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.eyJzdWIiOiIzMjYiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NjM2MjYzNjgsImV4cCI6MTc2NjIxODM2OCwianRpIjoiYzc4N2IyYjUtMzY0Yi00ZDIyLTgyNWYtOGZkOGYxYmVhN2FhIn0.XdgMgpGJ-4SSN3VkMnLY2cZ6zjgR0NuGwjfC8w6X7E8
Host: example.org
Cookie:

Query Parameters

by_licenses=["c1"]

Body

{
}

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/"f3d670c8b0bc2d7b8caccaf501fb79ec"
cache-control: max-age=0, private, must-revalidate
x-request-id: 4167ba54-2e5e-4008-870b-42f6fbf15f54
x-runtime: 0.012735
content-length: 251

Body

{
  "users": [
    {
      "id": 325,
      "archived": false,
      "created_at": "2025-11-20T08:12:48.302Z",
      "employment": true,
      "first_name": "Debbie",
      "hire_date": "2025-11-19",
      "last_name": "Spinka",
      "licences": [
        "c1"
      ],
      "profile_id": 95,
      "referral_code": "487788",
      "sign_up_method": "organic"
    }
  ]
}