Skip to main content
GET/v2/drivers

List Drivers

Returns all drivers for the carrier, paginated.

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
limitintegeroptionaldefault 100Records per page
pageintegeroptionaldefault 1Page number (1-indexed)

Responses

200OK— payload in data, wrapped in the response envelope.
FieldTypeDescription
driver_idUUIDUnique driver identifier
usernamestringDriver's login username
first_namestringFirst name
last_namestringLast name
activebooleanWhether the driver 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/drivers?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": [
    {
      "driver_id": "d4f7b2e9-1a3c-4d8f-b5e6-2c9a7d3f1e0b",
      "username": "jcarter01",
      "first_name": "James",
      "last_name": "Carter",
      "active": true
    },
    {
      "driver_id": "a9c3e7f2-6b4d-4a1e-c8d5-7f2b9e4a6c1d",
      "username": "mlopez42",
      "first_name": "Maria",
      "last_name": "Lopez",
      "active": true
    }
  ],
  "total_elements": 48,
  "page": 1,
  "size": 100,
  "total_pages": 1
}
Error response401
{
  "status_code": 401,
  "description": "Company API key is not valid",
  "data": null
}
esc