Models

The reusable object schemas the endpoints return. Every successful response wraps one of these in the response envelope.

Driver object

A driver in the carrier's fleet.

Field	Type	Description
`driver_id`	UUID	Unique driver identifier
`username`	string	Driver's login username
`first_name`	string	First name
`last_name`	string	Last name
`active`	boolean	Whether the driver is currently active

Remaining Hours-of-Service time per bucket (milliseconds) plus current duty status.

Field	Type	Description
`driver_id`	UUID	Unique driver identifier
`username`	string	Driver's login username
`break`	integer	Remaining break time (ms)
`drive`	integer	Remaining drive time (ms)
`shift`	integer	Remaining shift time (ms)
`cycle`	integer	Remaining cycle time (ms)
`current_status`	string	Current duty status code One of:`DS_DDS_ONDS_SBDS_OFFDR_IND_PCDR_IND_YM`

A vehicle in the carrier's fleet.

Field	Type	Description
`vehicle_id`	UUID	Unique vehicle identifier
`number`	string	Vehicle or unit number
`vin`	string	Vehicle Identification Number
`active`	boolean	Whether the vehicle is currently active

Most recent location and motion status for a vehicle.

Field	Type	Description
`vehicle_id`	UUID	Unique vehicle identifier
`number`	string	Vehicle or unit number
`odometer`	string	Odometer reading (miles)
`fuel_level`New	number	Fuel level as a percentage from 0 to 100. Returns 0 when the vehicle does not report fuel data.
`speed`	integer	Current speed (mph)
`lat`	string	Latitude
`lon`	string	Longitude
`status`	string	Current motion status One of:`IN_MOTIONSTATIONARYOFFLINE`
`timestamp`	string	Time of reading (UTC, ISO-8601)

Every successful response wraps its payload in this envelope.

Field	Type	Description
`description`	string	"success" on success, otherwise an error message.
`data`	object \| array \| null	The response payload — one record or an array of records.
`page`	integer	Current page (1-indexed) on paginated list endpoints.
`size`	integer	Number of items in this page.
`total_elements`	integer	Total records available across all pages.
`total_pages`	integer	Total number of pages. Stop when page ≥ total_pages.
`next_page_token`	string	Cursor for the next page (location history only).
`status_code`	integer	Present only on error responses.

Returned with any non-2xx status.

Field	Type	Description
`status_code`	integer	HTTP status code (e.g. 401).
`description`	string	Human-readable error message.
`data`	null	Always null on error.