WIwithterminal
Drivers

Get Driver

Changed on

Get the details of a specific driver

get/drivers/{id}

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/drivers/{id}
  • Auth
    HTTP bearer

Query parameters

rawboolean

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

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

idstring ulid required

Unique identifier for the driver in Terminal.

sourceIdstring required

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

providerstring required

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

status'active' | 'inactive' required

The status in the providers system

firstNamestring
middleNamestring
lastNamestring
emailstring email
phonestring

Phone number formatted in E.164 formatting

usernamestring

The driver's username for login purposes

createdAtstring 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.

updatedAtstring 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.

Example response

{
  "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": []
}

Changes

  • 71081936e1bdRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new provider_timeout enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      removed subschema #2: Expanded Group from the / response property oneOf list for the response status