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", "c", "ce", "c1", "c1e", "d", "d1", "d1e", "adr", "hiab", "phv"]

Request

Route

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

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIzMDkiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3Mzc1NTE1NTcsImV4cCI6MTc0MDE0MzU1NywianRpIjoiMDZjMjNkZGEtYmRjNS00Yjc2LWEyODYtOGNhYzQ3NDMyNGU3In0.EI5JtLH4-wCnKQxkxjXH6qf1YMDcRKudsKmeHHBvJAg
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/"bd301f3a6bb9dd61090954210510e0d0"
cache-control: max-age=0, private, must-revalidate
x-request-id: 78cedbe2-8f4e-4e9c-8339-d12c258b14e2
x-runtime: 0.013317
content-length: 225

Body

{
  "users": [
    {
      "id": 308,
      "archived": false,
      "created_at": "2025-01-22T13:12:37.785Z",
      "employment": true,
      "first_name": "Tamiko",
      "last_name": "Robel",
      "licences": [
        "c1"
      ],
      "profile_id": 88,
      "referral_code": "088088",
      "sign_up_method": "organic"
    }
  ]
}