Skip to main content
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

ParameterTypeDefaultDescription
statusstringoptionalFilter by 'active' or 'inactive'. Omit for all.
limitintegeroptionaldefault 100Records per page
pageintegeroptionaldefault 1Page number

Responses

200OK— payload in data, wrapped in the response envelope.
FieldTypeDescription
vehicle_idUUIDUnique vehicle identifier
numberstringVehicle or unit number
vinstringVehicle Identification Number
activebooleanWhether the vehicle is currently active
401Unauthorized— missing or invalid API key.
FieldTypeDescription
status_codeintegerHTTP status code (e.g. 401).
descriptionstringHuman-readable error message.
datanullAlways null on error.
Sample request
curl -X GET "https://api.huntereld.com/v2/vehicles?limit=100&page=1" \
  -H "X-API-Provider-Key: YOUR_PROVIDER_KEY" \
  -H "X-API-Company-Key: YOUR_COMPANY_KEY"
Example response200 OK
{
  "description": "success",
  "data": [
    {
      "vehicle_id": "e5c9f3b1-2d7a-4e8c-a6f3-9b1d4e7c2f5a",
      "number": "1042",
      "vin": "1XKYD49X3NJ312847",
      "active": true
    },
    {
      "vehicle_id": "a2f8d6c4-7b3e-4a9f-c1d8-4e6b2f9a3c7d",
      "number": "2087",
      "vin": "3AKJHHDV5MSLR8523",
      "active": true
    }
  ],
  "total_elements": 31,
  "page": 1,
  "size": 100,
  "total_pages": 1
}
Error response401
{
  "status_code": 401,
  "description": "Company API key is not valid",
  "data": null
}
esc