Authentication
Vehicles
Drivers
Devices
Groups
Data Management
Providers
Webhook Events
- Event Types
- connection.created
- connection.disconnected
- connection.reconnected
- connection.completed
- connection.updated
- sync.requested
- sync.started
- sync.completed
- sync.failed
- connection.first_sync_completed
- issue.reported
- issue.resolved
- unsupported_provider.requested
- vehicle.added
- vehicle.modified
- vehicle.removed
- driver.added
- driver.modified
- driver.removed
- safety_event.added
- safety_event.modified
List All Connections
List all of the connections you have for your application. Connections represent the authenticated access you have to your customer’s TSP data.
curl --request GET \
--url https://api.withterminal.com/tsp/v1/connections \
--header 'Authorization: Bearer <token>'
{
"results": [
{
"id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
"company": {
"name": "Frank's Trucking",
"dotNumbers": [
"1234567"
]
},
"account": {
"name": "Frank's Trucking",
"dotNumbers": [
"1234567"
],
"user": {
"sourceId": "1234567",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com"
}
},
"status": "connected",
"provider": {
"code": "geotab",
"name": "Geotab"
},
"externalId": "1234",
"sourceId": "123456789",
"syncMode": "automatic",
"token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
"tags": [
"Tag Name"
],
"options": {
"ingestHistoryFromSourceSystem": true
},
"filters": {
"vehicles": {
"status": "active",
"excludeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
},
"drivers": {
"status": "active",
"excludeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
}
},
"linkUrl": "https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}",
"createdAt": "2021-01-06T03:24:53.000Z",
"updatedAt": "2021-01-06T03:24:53.000Z"
}
],
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Pagination cursor to start requests from
"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
The maximum number of results to return in a page.
Filter connections by tag
Filter connections that were last updated on or after a given time.
"2021-01-06T03:24:53.000Z"
Filter connections that were last updated on or before a given time.
"2021-01-06T03:24:53.000Z"
Response
The connection your application has with your customer's TSP.
"conn_01GV12VR4DJP70GD1ZBK0SDWFH"
The name of the account according to the provider.
"Frank's Trucking"
DOT numbers associated with the account according to the provider.
The user of the provider account that created the connection.
Enum values:
connected
: active and authenticated connectiondisconnected
: connection is no longer authenticated - please ask your user to link the account againarchived
: connection has been archived from view - attempts to re-connect will cause us to check the connection status again
connected
, disconnected
, archived
, pending_deletion
Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.
"geotab"
The name of the Telematics Service Provider.
"Geotab"
Enum values:
automatic
: Terminal will keep this connections data up to datemanual
: Terminal will only sync data upon request
automatic
, manual
This token is used when interacting with a connections' data.
"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"
By default our system will ingest Vehicle Locations and Stat Logs from the source system. Omnitracs also supports history at a higher sample rate through a historical file process. If you are using these historical files and want to avoid mixing the data sources, set this to false.
An optional ID from your system that can be used to reference connections.
"1234"
The ID used in the source system to represent the account this connection has access to.
This may be an organizationId
or accountId
.
Note: not all systems expose this information, in which case it may be undefined.
"123456789"
An optional list of tags from your system that can be used to reference connections.
Filters applied to connection data
The URL to send your user to in order to have them re-authenticate the connection.
"https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}"
Cursor used for pagination.
"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
curl --request GET \
--url https://api.withterminal.com/tsp/v1/connections \
--header 'Authorization: Bearer <token>'
{
"results": [
{
"id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
"company": {
"name": "Frank's Trucking",
"dotNumbers": [
"1234567"
]
},
"account": {
"name": "Frank's Trucking",
"dotNumbers": [
"1234567"
],
"user": {
"sourceId": "1234567",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com"
}
},
"status": "connected",
"provider": {
"code": "geotab",
"name": "Geotab"
},
"externalId": "1234",
"sourceId": "123456789",
"syncMode": "automatic",
"token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
"tags": [
"Tag Name"
],
"options": {
"ingestHistoryFromSourceSystem": true
},
"filters": {
"vehicles": {
"status": "active",
"excludeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
},
"drivers": {
"status": "active",
"excludeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
}
},
"linkUrl": "https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}",
"createdAt": "2021-01-06T03:24:53.000Z",
"updatedAt": "2021-01-06T03:24:53.000Z"
}
],
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}