Terminal Drivers API
The Drivers API from Terminal — 2 operation(s) for drivers.
The Drivers API from Terminal — 2 operation(s) for drivers.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/terminal-telematics:terminal-telematics-drivers-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Terminal Telematics Drivers API
description: Terminal is a unified API that makes it easy to integrate with the leading telematics service providers.
version: '0.0'
contact:
name: Terminal
email: connect@withterminal.com
url: https://www.withterminal.com
servers:
- url: https://api.withterminal.com/tsp/v1
description: Production
- url: https://api.sandbox.withterminal.com/tsp/v1
description: Sandbox
security:
- Authorization: []
tags:
- name: Drivers
paths:
/drivers:
parameters: []
x-mcp:
enabled: true
get:
x-mcp: all
summary: List Drivers
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/Driver'
next:
$ref: '#/components/schemas/PaginationCursor'
required:
- results
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'410':
$ref: '#/components/responses/GoneError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
'500':
$ref: '#/components/responses/InternalServerError'
'504':
$ref: '#/components/responses/GatewayTimeoutError'
operationId: listDrivers
x-operation-category: core-data
x-required-permissions:
- driver:read
parameters:
- $ref: '#/components/parameters/ConnectionToken'
- $ref: '#/components/parameters/Cursor'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/ModifiedAfter'
- $ref: '#/components/parameters/ModifiedBefore'
- $ref: '#/components/parameters/Raw'
- $ref: '#/components/parameters/Hidden'
- $ref: '#/components/parameters/Deleted'
- schema:
type: string
enum:
- groups
in: query
name: expand
description: Expand resources in the returned response
tags:
- Drivers
description: List all of the drivers in the connected account
/drivers/{id}:
parameters:
- schema:
$ref: '#/components/schemas/DriverId'
name: id
in: path
required: true
x-mcp:
enabled: true
get:
x-mcp: all
summary: Get Driver
tags:
- Drivers
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Driver'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFoundError'
'410':
$ref: '#/components/responses/GoneError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
'500':
$ref: '#/components/responses/InternalServerError'
'504':
$ref: '#/components/responses/GatewayTimeoutError'
operationId: getDriver
x-operation-category: core-data
x-required-permissions:
- driver:read
parameters:
- $ref: '#/components/parameters/ConnectionToken'
- $ref: '#/components/parameters/Raw'
- schema:
type: string
enum:
- groups
in: query
name: expand
description: Expand resources in the returned response
description: Get the details of a specific driver
components:
schemas:
SourceId:
title: SourceId
type: string
example: '123456789'
description: The ID used to represent the entity in the source system.
ModifiedAt:
title: ModifiedAt
type: string
format: date-time
description: 'The date and time the record was last updated in Terminal. Note: this is not the date and time the record was updated in the provider''s system.'
ExpandedGroup:
title: Expanded Group
type: object
properties:
id:
$ref: '#/components/schemas/GroupId'
sourceId:
type: string
example: '12345'
provider:
$ref: '#/components/schemas/ProviderCode'
name:
type: string
example: California Division
description:
type: string
example: Resources part of the California division
parent:
$ref: '#/components/schemas/GroupId'
description: The parent of this group.
createdAt:
$ref: '#/components/schemas/SourceCreatedAt'
updatedAt:
$ref: '#/components/schemas/SourceUpdatedAt'
metadata:
$ref: '#/components/schemas/CoreEntityMetadata'
raw:
$ref: '#/components/schemas/RawDataList'
required:
- id
- sourceId
- provider
- metadata
x-description: A group represents a collection of assets (vehicles, trailers, drivers) defined by the provider.
Driver:
title: Driver
type: object
additionalProperties: false
x-model-category: entity
x-read-permission: driver:read
examples: []
properties:
id:
$ref: '#/components/schemas/DriverId'
sourceId:
$ref: '#/components/schemas/SourceId'
provider:
$ref: '#/components/schemas/ProviderCode'
status:
type: string
enum:
- active
- inactive
example: active
description: The status in the providers system
firstName:
type: string
example: Mike
middleName:
type: string
example: Bryan
lastName:
type: string
example: Miller
email:
type: string
format: email
example: driver@example.com
phone:
title: Phone
type: string
pattern: ^\+?\d{10,14}$
example: '+19058084567'
description: Phone number formatted in [E.164](https://www.twilio.com/docs/glossary/what-e164) formatting
username:
type: string
description: The driver's username for login purposes
example: driver123
license:
type: object
properties:
state:
$ref: '#/components/schemas/State'
number:
type: string
example: 123-456-789-0
groups:
type: array
description: The groups the driver belongs to.
items:
$ref: '#/components/schemas/ExpandableGroup'
createdAt:
$ref: '#/components/schemas/SourceCreatedAt'
updatedAt:
$ref: '#/components/schemas/SourceUpdatedAt'
metadata:
$ref: '#/components/schemas/CoreEntityMetadata'
raw:
$ref: '#/components/schemas/RawDataList'
required:
- id
- sourceId
- provider
- status
- metadata
x-description: The model representing a driver in Terminal.
DeletedAt:
title: DeletedAt
type: string
format: date-time
description: 'The date and time the record was deleted from Terminal. Note: this is not the date and time the record was deleted in the provider''s system.'
RawDataList:
title: RawDataList
type: array
example: []
items:
$ref: '#/components/schemas/RawData'
SourceCreatedAt:
title: SourceCreatedAt
type: string
format: date-time
description: '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.'
PaginationCursor:
title: Pagination Cursor
type: string
example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
description: Cursor used for pagination.
format: cursor
pattern: ^[A-Za-z0-9+/=_-]+$
AddedAt:
title: AddedAt
type: string
format: date-time
description: 'The date and time the record was ingested into Terminal. Note: this is not the date and time the record was created in the provider''s system.'
ErrorPathDetail:
title: ErrorPathDetail
type: object
properties:
message:
type: string
example: '''vehicleId'' property must be a valid ulid'
path:
type: string
example: '{requestQuery}.vehicleId'
suggestion:
type: string
example: Please ensure you submit a valid 'vehicleId' property
context:
type: object
required:
- message
- path
DriverId:
title: DriverId
description: Unique identifier for the driver in Terminal.
type: string
format: ulid
pattern: ^drv_[0-9A-HJKMNP-TV-Z]{26}$
example: drv_01D8ZQFGHVJ858NBF2Q7DV9MNC
RawData:
title: RawData
type: object
properties:
provider:
type: string
schema:
type: string
extractedAt:
type: string
data:
type: object
required:
- provider
- schema
- extractedAt
- data
GroupId:
title: GroupId
type: string
format: ulid
example: group_01D8ZQFGHVJ858NBF2Q7DV9MNC
State:
title: State
type: string
enum:
- AL
- AK
- AS
- AZ
- AR
- CA
- CO
- CT
- DE
- FL
- GA
- GU
- HI
- ID
- IL
- IN
- IA
- KS
- KY
- LA
- ME
- MD
- MA
- MI
- MN
- MP
- MS
- MO
- MT
- NE
- NV
- NH
- NJ
- NM
- NY
- NC
- ND
- OH
- OK
- OR
- PA
- PR
- RI
- SC
- SD
- TN
- TX
- UT
- VT
- VA
- WA
- WV
- WI
- WY
- VI
- AB
- BC
- MB
- NB
- NL
- NS
- 'ON'
- PE
- QC
- SK
- NT
- NU
- UM
- YT
- DC
example: TN
description: US State or Canadian Province
SourceUpdatedAt:
title: SourceUpdatedAt
type: string
format: date-time
description: '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.'
ExpandableGroup:
example: group_01D8ZQFGHVJ858NBF2Q7DV9MNC
oneOf:
- $ref: '#/components/schemas/GroupId'
- $ref: '#/components/schemas/ExpandedGroup'
ProviderCode:
type: string
example: geotab
description: Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under [provider details](/providers).
CoreEntityMetadata:
title: CoreEntityMetadata
type: object
description: Internal metadata about the record.
required:
- addedAt
- modifiedAt
properties:
addedAt:
$ref: '#/components/schemas/AddedAt'
modifiedAt:
$ref: '#/components/schemas/ModifiedAt'
deletedAt:
$ref: '#/components/schemas/DeletedAt'
visibility:
type: string
enum:
- visible
- hidden_by_exclude_list
- hidden_by_include_list
- hidden_by_status
- deleted
example: visible
description: Visibility status of a resource. Read more about hidden records [here](https://docs.withterminal.com/guides/vehicle-driver-filtering).
parameters:
Raw:
name: raw
in: query
required: false
schema:
type: boolean
description: Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.
ConnectionToken:
name: Connection-Token
in: header
required: true
schema:
type: string
example: con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4
pattern: ^con_tkn_\S+$
description: The token returned when a user authenticated their account. This authorizes access to a specific account.
Hidden:
name: hidden
in: query
required: false
schema:
type: boolean
description: Show hidden records that don't match the configured filters. Defaults to false.
Limit:
name: limit
in: query
required: false
schema:
type: integer
description: The maximum number of results to return in a page.
ModifiedBefore:
name: modifiedBefore
in: query
required: false
schema:
type: string
format: date-time
example: '2021-01-06T03:24:53.000Z'
description: Only include records that were last modified before a provided date.
Cursor:
name: cursor
in: query
schema:
type: string
format: cursor
pattern: ^[A-Za-z0-9+/=_-]+$
example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
description: Pagination cursor to start requests from
ModifiedAfter:
name: modifiedAfter
in: query
required: false
schema:
type: string
format: date-time
example: '2021-01-06T03:24:53.000Z'
description: Only include records that were last modified after a provided date.
Deleted:
name: deleted
in: query
required: false
schema:
type: boolean
description: Show "soft-deleted" records that have been deleted from the provider. Defaults to false.
responses:
GoneError:
description: Gone
content:
application/json:
schema:
type: object
properties:
code:
enum:
- gone
- connection_deleted
example: connection_deleted
message:
type: string
example: Connection has been deleted and cannot be used
required:
- code
- message
BadRequestError:
description: Bad Request
content:
application/json:
schema:
type: object
properties:
code:
enum:
- bad_request
message:
type: string
example: Invalid request body
detail:
type: array
items:
$ref: '#/components/schemas/ErrorPathDetail'
required:
- code
- message
GatewayTimeoutError:
description: Gateway Timeout Error
content:
application/json:
schema:
type: object
properties:
code:
enum:
- gateway_timeout
- provider_timeout
description: '`provider_timeout` means the telematics provider did not respond in time, or responded too slowly to finish the request (for example, while paginating). Retry later or narrow the request, for example with a shorter time range or smaller `limit`. `gateway_timeout` means Terminal could not finish the request in time for another reason.'
message:
type: string
example: Gateway Timeout
required:
- code
- message
TooManyRequestsError:
description: Too Many Requests
content:
application/json:
schema:
type: object
additionalProperties: true
properties:
code:
enum:
- too_many_requests
retryAfter:
description: The number of seconds to wait before retrying the request
type: integer
example: 60
message:
type: string
example: Too Many Requests
detail:
type: string
example: You have exceeded your rate limit. Please try again later.
required:
- code
- message
UnauthorizedError:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
code:
enum:
- unauthorized
message:
type: string
example: Unauthorized Request
detail:
type: string
example: Please ensure you have a valid API key
required:
- code
- message
InternalServerError:
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
code:
enum:
- internal_server_error
message:
type: string
example: Internal Server Error
detail:
type: string
example: Something went wrong
required:
- code
- message
NotFoundError:
description: Not Found
content:
application/json:
schema:
type: object
properties:
code:
enum:
- not_found
message:
type: string
example: Resource not found
detail:
type: string
example: 'Could not find resource with ID: 2342342'
required:
- code
- message
ForbiddenError:
description: Forbidden
content:
application/json:
schema:
type: object
properties:
code:
enum:
- forbidden
message:
type: string
example: Forbidden Request
detail:
type: string
example: Please ensure the connection token matches the resource you are attempting to access.
required:
- code
- message
securitySchemes:
Authorization:
type: http
scheme: bearer