v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Lookup a vehicle (External Identifier)

get/v1/vehicles/lookup_by_external_id

Query parameters

idinteger required

The unique identifier assigned to the external ID.

external_idstring required

Specify the external id of the vehicle. This ID is assigned by a third-party integration or a tool.

integration_namestring required

Mention the name of the integration that assigned the external Id to the vehicle.

Headers

X-Time-Zonestring

X-Time-Zone

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Response

200

Example response

{
  "vehicle": {
    "id": 4,
    "company_id": 5,
    "number": "Demo Vehicle",
    "status": "active",
    "ifta": true,
    "vin": "WP0AB2966NS458669",
    "make": "Demo",
    "model": "Vehicle",
    "year": "2016",
    "license_plate_state": "CA",
    "license_plate_number": "5M37250",
    "fuel_type": "diesel",
    "created_at": "2019-01-19T20:48:57Z",
    "updated_at": "2019-01-19T21:23:44Z",
    "eld_device": {
      "id": 2,
      "identifier": "000074802542164638439715893965",
      "model": "lbb-1"
    },
    "current_driver": {
      "id": 11,
      "first_name": "Demo",
      "last_name": "Driver",
      "username": "demo_driver",
      "status": "active",
      "role": "driver"
    },
    "carb_ctc_test_enabled": "true",
    "carb_ctc_emission_status": "compliant",
    "registration_expiry_date": "2025-12-24"
  }
}