GET /v2/vehicles

List Vehicles

Returns all vehicles in the carrier's fleet.

Pagination
Start at page=1 and keep requesting while page is less than total_pages. Every response reports page, size, total_elements, and total_pages in the response envelope.

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.

Query parameters

Parameter Type Default Description
status string optional — Filter by 'active' or 'inactive'. Omit for all.
limit integer optional default 100 Records per page
page integer optional default 1 Page number

Responses

200 OK Success — payload in data, wrapped in the response envelope.
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
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.