Drivers

List all drivers

GET drivers

Endpoint

GET /api/v1/drivers

Parameters

Name Description In
page Page number
per_page Per page
by_name Filter by name
by_company Filter by company
by_job_number Filter by job number
from_date Filter by from date
to_date Filter by to date
by_licenses Filter by license ["b", "b1", "c", "ce", "c1", "c1e", "d", "d1", "d1e", "adr", "hiab", "phv"]
by_state Filter by state ["active_drivers"]

Request

Route

GET /api/v1/drivers?by_licenses[]=c1

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIzMTYiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NDI0NjQ5MTIsImV4cCI6MTc0NTA1NjkxMiwianRpIjoiNjY4MDRkN2MtZWJkZS00ZjkxLWIxYzQtNDYyMzZiYWM1MzlkIn0.kz2pMA8YJPzK3mNDfEPhN58_BJhuTULIlhFRvGhkH2A
Host: example.org
Cookie:

Query Parameters

by_licenses=["c1"]

Response

Simulated Response

Status

200

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
per-page: 20
total: 1
content-type: application/json; charset=utf-8
vary: Accept, Origin
etag: W/"254792c44662479b80505defd7a4be3d"
cache-control: max-age=0, private, must-revalidate
x-request-id: 8655fede-f631-48b4-8dd6-da05110a36d7
x-runtime: 0.013140
content-length: 247

Body

{
  "users": [
    {
      "id": 315,
      "archived": false,
      "created_at": "2025-03-20T10:01:52.737Z",
      "employment": true,
      "first_name": "Jc",
      "hire_date": "2025-03-19",
      "last_name": "Hessel",
      "licences": [
        "c1"
      ],
      "profile_id": 89,
      "referral_code": "161490",
      "sign_up_method": "organic"
    }
  ]
}