Skip to main content
GET
/
vehicle
Get all vehicle profiles
curl --request GET \
  --url https://ctechnology.io/api/v2.2/vehicle \
  --header 'Authorization: <api-key>'
{
  "header": {
    "num_results": 123,
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "via": "me",
        "organization_id": "<string>"
      }
    ],
    "offset": 123,
    "limit": 123
  },
  "data": [
    {
      "id": "<string>",
      "vehicle_type": "BOAT",
      "drivetrain_type": "GASOLINE",
      "device_id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "desc": "<string>",
      "image_url": "<string>",
      "delivery_date": "2023-11-07T05:31:56Z",
      "ain_1_type": "NONE",
      "ain_2_type": "NONE",
      "ain_3_type": "NONE",
      "ain_4_type": "NONE",
      "din_1_type": "NONE",
      "din_2_type": "NONE",
      "din_3_type": "NONE",
      "din_4_type": "NONE",
      "din_5_type": "NONE",
      "dout_1_type": "NONE",
      "dout_2_type": "NONE",
      "dout_3_type": "NONE",
      "dout_4_type": "NONE",
      "ble_temp_type": "<string>",
      "temp_1_desc": "<string>",
      "temp_2_desc": "<string>",
      "temp_3_desc": "<string>",
      "temp_4_desc": "<string>",
      "battery_main_model": "12V-DEF",
      "battery_main_desc": "<string>",
      "battery_ext_1_model": "12V-DEF",
      "battery_ext_1_desc": "<string>",
      "device_angle_offset": 123,
      "tank_size": 123,
      "can_readout": true,
      "obd2_readout": true,
      "n2k_readout": true,
      "hibernation_mode": true,
      "maintenance_can_distance": true,
      "hardware_type": "<string>",
      "protocol_type": "<string>",
      "bluetooth": true,
      "bluetooth_address": "<string>",
      "development_vehicle": true,
      "sim_type": "<string>",
      "processing_pipeline": "<string>",
      "processing_pipeline_module_options_overrides": "<unknown>",
      "brand": "<string>",
      "description": "<string>",
      "image_id": "<string>",
      "group_id": "<string>",
      "primary_organization_id": "<string>",
      "manufacturing_organization_id": "<string>",
      "professional_vehicle_id": "<string>",
      "professional_vehicle_name": "<string>",
      "professional_location_main_lon": 123,
      "professional_location_main_lat": 123,
      "professional_location_main_desc": "<string>",
      "oem_vehicle_id": "<string>",
      "oem_vehicle_type_id": "<string>",
      "vehicle_registration_id": "<string>",
      "vehicle_identification_number": "<string>",
      "ain_1_desc": "<string>",
      "ain_2_desc": "<string>",
      "ain_3_desc": "<string>",
      "ain_4_desc": "<string>",
      "din_1_desc": "<string>",
      "din_2_desc": "<string>",
      "din_3_desc": "<string>",
      "din_4_desc": "<string>",
      "din_5_desc": "<string>",
      "dout_1_desc": "<string>",
      "dout_2_desc": "<string>",
      "dout_3_desc": "<string>",
      "dout_4_desc": "<string>",
      "battery_ext_2_model": "12V-DEF",
      "battery_ext_2_desc": "<string>",
      "battery_ext_3_model": "12V-DEF",
      "battery_ext_3_desc": "<string>",
      "battery_ext_4_model": "12V-DEF",
      "battery_ext_4_desc": "<string>",
      "tank_prefer_analog": true,
      "transport_mode": true,
      "notrack_mode": true,
      "notrack_mode_deact_time": "2023-11-07T05:31:56Z",
      "function_control_mode_deact_time": "2023-11-07T05:31:56Z",
      "subscription": {
        "id": "<string>",
        "timestamp_start": "2023-11-07T05:31:56Z",
        "timestamp_end": "2023-11-07T05:31:56Z",
        "service_type": "BASE",
        "origin_type": "SUBSCR_STRIPE",
        "user_id": "<string>",
        "vehicle_id": "<string>",
        "stripe_subscription": "<string>",
        "voucher_id": 123
      },
      "organization_vehicles": [
        {
          "id": "<string>",
          "organization_id": "<string>",
          "vehicle_id": "<string>",
          "vehicle_device_id": "<string>",
          "role": "VEHICLE_OWNER",
          "primary_organization": true,
          "manufacturing_organization": true,
          "vehicle_category_id": "<string>",
          "vehicle_category_name": "<string>",
          "vehicle_family_id": "<string>",
          "vehicle_family_name": "<string>",
          "vehicle_type_id": "<string>",
          "vehicle_type_name": "<string>",
          "vehicle_type_image_url": "<string>",
          "organization_vehicle_id": "<string>",
          "organization_vehicle_name": "<string>",
          "organization_vehicle_desc": "<string>",
          "vehicle_type_max_speed": 123,
          "vehicle_type_battery_capacity_wh": 123,
          "vehicle_type_avg_consumption_wh_per_km": 123,
          "vehicle_type_tank_capacity_l": 123,
          "vehicle_type_avg_consumption_l_per_100km": 123,
          "drivetrain_type": "ELECTRIC",
          "location_main_desc": "<string>"
        }
      ],
      "initial_distance": 123,
      "initial_operation_hours": 123,
      "initial_date": "2023-12-25",
      "initialization_complete": true,
      "auto_discover_home": true,
      "trips_end_at_home": true,
      "remove_trip_points_on_land": true,
      "boat_type": "MOTORBOAT",
      "vehicle_length_m": 123,
      "vehicle_depth_m": 123,
      "vehicle_height_m": 123,
      "vehicle_weight_kg": 123,
      "main_battery_property_pct": "<string>",
      "main_fuel_property_pct": "<string>",
      "display_settings": {
        "webapp_sidebar_slot_1": "<string>",
        "webapp_sidebar_slot_2": "<string>",
        "nativeapp_dashboard_main": "<string>",
        "nativeapp_four_most_important_1": "<string>",
        "nativeapp_four_most_important_2": "<string>",
        "nativeapp_four_most_important_3": "<string>",
        "nativeapp_four_most_important_4": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Note that the API key has to be sent as Token 123 where 123 is the key you received after logging in or by creating on the developer dashboard.

Query Parameters

offset
integer
default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0
limit
integer
default:8

The numbers of items to return.

Required range: x >= 0
filter_text
string

A free-text filter that is applied on various fields.

Response

Successful retrieval of all vehicle profiles.

header
API Header Paginated · object
required

Default header sent along with multi-resource responses (lists of resources).

data
Vehicle Profile · object[]
required

A list of vehicle profiles.