Skip to main content
GET
/
drivers
/
{id}
Get Driver
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/drivers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "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": []
}

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"

Path Parameters

id
string
required

Query Parameters

raw
boolean

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

expand
enum<string>

Expand resources in the returned response

Available options:
groups

Response

OK

id
string<ulid>
required

Unique identifier for the driver in Terminal.

Example:

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

sourceId
string
required

The ID used to represent the entity in the source system.

Example:

"123456789"

provider
string
required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

status
enum<string>
required

The status in the providers system

Available options:
active,
inactive
metadata
object
required

Internal metadata about the record.

firstName
string
Example:

"Mike"

middleName
string
Example:

"Bryan"

lastName
string
Example:

"Miller"

email
string<email>
Example:

"driver@example.com"

phone
string

Phone number formatted in E.164 formatting

Example:

"+19058084567"

username
string

The driver's username for login purposes

Example:

"driver123"

license
object
groups
(string<ulid> | Expanded Group · object)[]
createdAt
string<date-time>

The date and time the record was created in the provider's system. This timestamp comes directly from the source system and represents when the data was originally created there. Note: not all providers expose this.

updatedAt
string<date-time>

The date and time the record was updated in the provider's system. This timestamp comes directly from the source system and represents when the data was last updated there. Note: not all providers expose this.

raw
RawData · object[]
Example:
[]
I