Terminal Providers API
The Providers API from Terminal — 1 operation(s) for providers.
The Providers API from Terminal — 1 operation(s) for providers.
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-providers-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 Providers 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: Providers
paths:
/providers:
parameters: []
x-mcp:
enabled: true
get:
x-mcp: all
summary: List Providers
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Provider'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
'500':
$ref: '#/components/responses/InternalServerError'
'504':
$ref: '#/components/responses/GatewayTimeoutError'
operationId: listProviders
x-operation-category: control-plane
parameters: []
description: Retrieve a list of the providers Terminal supports. This endpoint will grow to include additional details about the supported capabilities of each provider.
tags:
- Providers
components:
responses:
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
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
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
schemas:
ModelSupportedOperations:
title: ModelSupportedOperations
description: Common structure for model support status containing the supported operations.
type: object
required:
- supportedOperations
properties:
supportedOperations:
type: object
required:
- read
properties:
read:
$ref: '#/components/schemas/SupportStatus'
ProviderModelSupport:
title: ProviderModelSupport
type: object
properties:
Group:
$ref: '#/components/schemas/ModelSupportedOperations'
Vehicle:
$ref: '#/components/schemas/ModelSupportedOperations'
Driver:
$ref: '#/components/schemas/ModelSupportedOperations'
LatestVehicleLocation:
$ref: '#/components/schemas/ModelSupportedOperations'
VehicleLocation:
allOf:
- $ref: '#/components/schemas/ModelSupportedOperations'
- type: object
required:
- sampleRate
properties:
sampleRate:
type: string
description: How frequently is data captured by the vehicle
example: 30 seconds
availableHistory:
type: string
example: 1 year
description: How much history is available to backfill. No history is available if undefined.
VehicleStatLog:
allOf:
- $ref: '#/components/schemas/ModelSupportedOperations'
- type: object
required:
- types
properties:
types:
type: array
description: The types of vehicle stat logs that are supported by this provider.
example:
- odometer
- engine_state
- fuel_level
- engine_runtime
items:
$ref: '#/components/schemas/VehicleStatLogType'
Trailer:
$ref: '#/components/schemas/ModelSupportedOperations'
LatestTrailerLocation:
$ref: '#/components/schemas/ModelSupportedOperations'
Trip:
$ref: '#/components/schemas/ModelSupportedOperations'
Device:
$ref: '#/components/schemas/ModelSupportedOperations'
HOSLog:
$ref: '#/components/schemas/ModelSupportedOperations'
HOSDailyLog:
$ref: '#/components/schemas/ModelSupportedOperations'
HOSAvailableTime:
$ref: '#/components/schemas/ModelSupportedOperations'
IFTASummary:
$ref: '#/components/schemas/ModelSupportedOperations'
SafetyEvent:
allOf:
- $ref: '#/components/schemas/ModelSupportedOperations'
- type: object
required:
- types
properties:
types:
type: array
description: The types of safety events that are supported by this provider.
example:
- speeding
- harsh_brake
- harsh_acceleration
- harsh_turn
- crash
items:
$ref: '#/components/schemas/SafetyEventType'
CameraMedia:
$ref: '#/components/schemas/ModelSupportedOperations'
FaultCodeEvent:
$ref: '#/components/schemas/ModelSupportedOperations'
VehicleUtilization:
$ref: '#/components/schemas/ModelSupportedOperations'
required:
- Group
- Vehicle
- Driver
- VehicleLocation
- LatestVehicleLocation
- VehicleStatLog
- Trailer
- LatestTrailerLocation
- Trip
- Device
- HOSLog
- HOSDailyLog
- HOSAvailableTime
- IFTASummary
- SafetyEvent
- CameraMedia
- FaultCodeEvent
- VehicleUtilization
ProviderPassthroughSupport:
title: ProviderPassthroughSupport
description: Provider-level passthrough request support.
type: object
required:
- supported
properties:
supported:
type: boolean
description: Whether Terminal supports authenticated passthrough requests for this provider.
Provider:
title: Provider
type: object
properties:
name:
type: string
example: Geotab
code:
$ref: '#/components/schemas/ProviderCode'
baseCode:
type: string
example: geotab
description: The base provider code that this provider is built on. Only visible to authenticated users. Used to identify providers that share the same underlying technology platform.
status:
title: ProviderStatus
type: string
enum:
- live
- beta
- sandbox
- deprecated
description: The status of the provider.
logo:
type: string
format: uri
example: https://cdn.withterminal.com/providers/geotab/logo.png
icon:
type: string
format: uri
example: https://cdn.withterminal.com/providers/geotab/icon.png
references:
type: array
description: Additional reference links for the provider (e.g., login pages)
items:
type: object
properties:
type:
type: string
enum:
- login-page
- password-reset
- developer-docs
description: The type of reference
url:
type: string
description: The URL of the reference
label:
type: string
description: The display label for the reference
required:
- type
- url
- label
supportedModels:
$ref: '#/components/schemas/ProviderModelSupport'
passthrough:
$ref: '#/components/schemas/ProviderPassthroughSupport'
required:
- code
- name
- status
- logo
- icon
- supportedModels
- passthrough
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
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).
SafetyEventType:
title: SafetyEventType
type: string
example: crash
enum:
- harsh_brake
- harsh_acceleration
- harsh_turn
- speeding
- crash
- near_crash
- tailgating
- cell_phone
- distracted
- drowsiness
- smoking
- seat_belt_violation
- stop_sign_violation
- red_light_violation
- unsafe_lane_change
- camera_obstruction
- eating_and_drinking
- rolling_stop
- unsafe_parking
SupportStatus:
type: string
description: 'Enum values:
- `supported`: Terminal supports this resource
- `not_supported_by_terminal`: Terminal does not support this resource
- `not_supported_by_provider`: The provider does not support this resource'
enum:
- supported
- not_supported_by_terminal
- not_supported_by_provider
VehicleStatLogType:
title: VehicleStatLogType
type: string
enum:
- engine_state
- odometer
- total_fuel_consumption
- fuel_level
- engine_runtime
- engine_oil_percentage
- engine_oil_pressure
- engine_oil_temperature
- engine_coolant_temperature
- coolant_percentage
- engine_rpm
- battery_voltage
securitySchemes:
Authorization:
type: http
scheme: bearer