Skip to main content

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.

in_cab_trip_mode: str | None = None
Controls what visibility driver has on in cab app.

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.

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

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

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

[
  {
    "id": "string",
    "name": "string",
    "username": "string",
    "depot_id": "string",
    "depot_name": "string",
    "in_cab_trip_mode": "all",
    "in_cab_supply_option_mode": "disabled",
    "trailer_number": "string",
    "trailer_id": "string",
    "tractor_number": "string",
    "tractor_id": "string",
    "updated_on": "2026-05-11T19:25:52.333Z",
    "extra_data": {},
    "cards": [
      {
        "card_id": "string",
        "terminal_id": "string",
        "certification_date": "2026-05-11T19:25:52.333Z",
        "activity_count": 0
      }
    ],
    "credentials": [
      {
        "credential_id": "string",
        "certification_date": "2026-05-11T19:25:52.333Z"
      }
    ],
    "preferred_template": "string",
    "preferred_template_id": "string",
    "shift_preference": "am",
    "pay_config": {
      "details": [
        {
          "start_date": "2026-05-11T19:25:52.333Z",
          "end_date": "2026-05-11T19:25:52.333Z",
          "name": "string"
        }
      ],
      "updated_on": "2026-05-11T19:25:52.333Z",
      "updated_by": "string"
    }
  }
]
Loading...