GET /v2/vehicle-location-history/{vehicle_id}

Vehicle Location History

Returns a vehicle's historical GPS breadcrumbs for up to the last 6 months.

Token-based pagination
Tokens are tied to the original vehicle_id, start_date, and end_date. Changing any of those requires a new query. You cannot page backwards.

Authentication

Send both headers on every request. How auth works →
  • X-API-Provider-Key Your provider key Identifies your platform. The same for every request.
  • X-API-Company-Key The carrier's company key Scopes all returned data to that one carrier.

Path parameters

Parameter Type Description
vehicle_id UUID required The vehicle's unique identifier

Query parameters

Parameter Type Default Description
start_date string required — Format MM-DD-YYYY
end_date string required — Format MM-DD-YYYY
limit integer optional default 100 Records per page
next_page_token string optional — From the previous response

Responses

200 OK Success — payload in data, wrapped in the response envelope.
Field Type Description
id UUID Unique record identifier
vehicle_number string Vehicle or unit number
vin string Vehicle Identification Number
lat string Latitude
lng string Longitude
status string Motion status at the reading
One of: IN_MOTIONSTATIONARYOFFLINE
speed string Speed at the reading (mph)
timestamp string Time of reading (UTC, ISO-8601)
calc_location string Human-readable location
direction string Heading in degrees (0–360)
next_page_token string Pass back in your next request. Absent on last page.
401 Unauthorized Missing or invalid API key.
Field Type Description
status_code integer HTTP status code (e.g. 401).
description string Human-readable error message.
data null Always null on error.