Driver All Ep

POST /v1/driver/all

Driver All

Retrieves detailed information about all drivers in the system, including their associated depot and vehicle information.

Required Scopes (idi.r)

Response

id: str
The internal identifier for the driver.

name: str
The name of the driver.

username: str
The unique username assigned to each driver.

depot_id: int | None = None
The internal identifier of the depot associated with the driver.

depot_name: str | None = None
The name of the depot associated with the driver.

trailer_number: str | None = None
The trailer number assigned to the driver’s trailer.

trailer_id: str | None = None
The internal identifier of the driver’s assigned trailer.

tractor_number: str | None = None
The tractor number assigned to the driver’s tractor.

tractor_id: str | None = None
The internal identifier of the driver’s assigned tractor.

shift_preference: Shift = am
The driver’s shift preference. One of am or pm.

preferred_template: str | None = None
The name of the driver’s preferred shift template.

preferred_template_id: str | None = None
The internal identifier of the driver’s preferred shift template.

in_cab_view_mode: InCabViewMode = all
Controls how much of the driver’s schedule is visible in the in-cab app.

Show In Cab View Modes

current
Only the current stop is visible.

restricted
A restricted subset of the schedule is visible.

all
The whole of the current trip is visible.

all and next
The current trip and the next trip are visible.

in_cab_trip_changes: InCabTripChanges = none
Controls what resequencing the driver may perform from the in-cab app.

Show In Cab Trip Changes

none
The driver cannot resequence.

resequence stops
The driver may reorder stops.

resequence orders
The driver may reorder orders.

resequence orders and stops
The driver may reorder both orders and stops.

in_cab_supply_option_mode: InCabSupplyOptionMode = disabled
Controls when the driver may change the supply option on an order from the in-cab app.

Show In Cab Supply Option Modes

disabled
The driver cannot change supply.

terminal
The driver may change supply at the terminal.

order_start
The driver may change supply at the start of the order.

terminal_and_order_start
The driver may change supply at the terminal and at the start of the order.

in_cab_trip_mode: InCabTripMode = all
Deprecated. The combined view/resequencing mode, kept in sync with in_cab_view_mode and in_cab_trip_changes. Use those two fields instead.

Show Supported Modes

current
Driver can only view current trip.

all
Driver can view all trips on their shift.

restricted
Driver can view all stops but not the load or drop information.

all and next
Driver can view all trips on their shift and preview next shift after completion.

resequence stops
Driver can reorder stops.

resequence orders
Driver can reorder orders.

resequence orders and stops
Driver can reorder both orders and stops.

cards: list[DriverTerminalCardView] | None = []
The terminal cards issued to the driver.

Show Child Attributes

card_id: str
Internal identifier of the card.

terminal_id: str
Internal identifier of the terminal the card is valid at.

certification_date: datetime | None = None
The date the driver was certified for this card.

activity_count: int | None = 0
The number of recorded activities against this card.

credentials: list[DriverCredentialView] | None = []
The credentials held by the driver.

Show Child Attributes

credential_id: str
Internal identifier of the credential.

certification_date: datetime | None = None
The date the driver was certified for this credential.

pay_config: object | None = None
The driver's pay configuration history, including the effective-dated list of pay configs and audit metadata.

Show Pay Config Fields

details: list[object] = []
The history of pay configs assigned to the driver.

Details

Show details fields

start_date: datetime | None
the date this pay config becomes effective.

end_date: datetime | None
the date this pay config stops being effective.

name: str | None
the name of the pay config.

updated_on: datetime
The timestamp of the most recent update to the pay config.

updated_by: str | None = None
The user who most recently updated the pay config.

updated_on: datetime | None = None
The timestamp of the most recent update to the driver data.

extra_data: object | None = {}
Any additional data about the driver that is provided or managed by the client through integration endpoints.

Responses

Successful Response

application/json

Example (from schema)

[
  {
    "id": "string",
    "name": "string",
    "username": "string",
    "depot_id": "string",
    "depot_name": "string",
    "in_cab_trip_mode": "all",
    "in_cab_view_mode": "all",
    "in_cab_trip_changes": "none",
    "in_cab_supply_option_mode": "disabled",
    "trailer_number": "string",
    "trailer_id": "string",
    "tractor_number": "string",
    "tractor_id": "string",
    "updated_on": "2026-09-25T19:33:18.185Z",
    "extra_data": {},
    "cards": [
      {
        "card_id": "string",
        "terminal_id": "string",
        "certification_date": "2026-09-25T19:33:18.185Z",
        "activity_count": 0
      }
    ],
    "credentials": [
      {
        "credential_id": "string",
        "certification_date": "2026-09-25T19:33:18.185Z"
      }
    ],
    "preferred_template": "string",
    "preferred_template_id": "string",
    "shift_preference": "am",
    "pay_config": {
      "details": [
        {
          "start_date": "2026-09-25T19:33:18.186Z",
          "end_date": "2026-09-25T19:33:18.186Z",
          "name": "string"
        }
      ],
      "updated_on": "2026-09-25T19:33:18.186Z",
      "updated_by": "string"
    }
  }
]

Driver All Ep

/v1/driver/all

Driver All

Response​

Responses​

Response

Responses