Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Drivers

List Drivers

List all of the drivers in the connected account

get/drivers

Query parameters

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

limitinteger

The maximum number of results to return in a page.

modifiedAfterstring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified after a provided date.

modifiedBeforestring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified before a provided date.

rawboolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

hiddenboolean

Show hidden records that don't match the configured filters. Defaults to false.

deletedboolean

Show "soft-deleted" records that have been deleted from the provider. Defaults to false.

expand'groups'

Expand resources in the returned response

Headers

X-Application-Idstring

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

The token returned when a user authenticated their account. This authorizes access to a specific account.

Response

OK

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "id": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "status": "active",
      "firstName": "Mike",
      "middleName": "Bryan",
      "lastName": "Miller",
      "email": "driver@example.com",
      "phone": "+19058084567",
      "username": "driver123",
      "license": {
        "state": "TN",
        "number": "123-456-789-0"
      },
      "groups": [
        "group_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "metadata": {
        "visibility": "visible"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}