GET
/
drivers
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/drivers \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "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"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {
        "addedAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "visibility": "visible"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Connection-Token
string
required

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

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

​
cursor
string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

​
limit
integer

The maximum number of results to return in a page.

​
modifiedAfter
string

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

Example:

"2021-01-06T03:24:53.000Z"

​
modifiedBefore
string

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

Example:

"2021-01-06T03:24:53.000Z"

​
raw
boolean

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

​
hidden
boolean

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

​
deleted
boolean

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

​
expand
enum<string>

Expand resources in the returned response

Available options:
groups

Response

200
application/json

OK

​
results
Driver · object[]
required
​
next
string

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"