v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Fetch a vehicle's location using its ID (v2)

get/v2/vehicle_locations/{id}

Path parameters

idstring required

Specify the unique identifier of the vehicle.

Query parameters

start_datestring date required

Specify the start date from which you want to fetch the vehicle's location history.

end_datestring date required

Provide the end date for when you want to check the location history of the vehicle.

updated_afterstring date required

Provide the date after which the location records have been updated.

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

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_locations": [
    {
      "vehicle_location": {
        "id": "d1671b6d-d2ba-49f4-b8c3-8d0782a50d44",
        "located_at": "2016-05-24T09:01:11Z",
        "lat": 123,
        "lon": 456,
        "bearing": 2.24,
        "battery_voltage": 12.5,
        "engine_hours": 244.22,
        "type": "breadcrumb",
        "description": "6.2 mi N of San Francisco, CA",
        "speed": 40.4,
        "odometer": 5.58623553,
        "fuel": 1.34645126,
        "fuel_primary_remaining_percentage": 50.5,
        "fuel_secondary_remaining_percentage": 90.5,
        "driver": {
          "id": 464394,
          "first_name": "John",
          "last_name": "Doe",
          "username": "john.doe",
          "driver_company_id": "kt002",
          "status": "active",
          "role": "driver"
        },
        "eld_device": {
          "id": 7224,
          "identifier": "00012835",
          "model": "lbb-2"
        }
      }
    }
  ]
}