Authentication
Vehicles
Drivers
Devices
Groups
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"
]
},
"status": "connected",
"options": {
"ingestHistoryFromSourceSystem": true
},
"provider": {
"code": "geotab",
"name": "Geotab"
},
"externalId": "1234",
"sourceId": "123456789",
"syncMode": "automatic",
"token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
"tags": [
"Tag Name"
],
"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
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.
Filter connections that were last updated on or before a given time.
Response
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 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.
azuga, bigroad, conti-go, eld-mandate, eld-mandate-plus, eld-mandate-hos, eld-rider, eldone, envue-telematics, eroad, eva-eld, attrix, advantage-one, argos, fleet-profit-center, gps-tracking-canada, graybox-solutions, gridline, high-point-gps, io-tab, blue-arrow, eagle-wireless, fleet-complete-hub, fleetistics, fort-knox, fm-eld, geotab, gofleet, gogps, gps-insight, gpstab, isaac, ksk, switchboard, linxup, coretex-360, apollo, apollo-eld, apollo-compass, top-tracking-system, eld-mandate-prime, hos-reporter-plus, hos247, black-bear, columbus-eld, phoenix-eld, route-eld, reliable-eld, trust-eld, abc-eld, tempus-eld, vlog-eld, just-eld, factor-eld, moonlight-eld, daily-eld, dfl-eld, hero-eld, infinity-eld, ampm-eld, forza-eld, action-eld, state-elog, dy-eld, cobra-eld, flash-elogs, renaissance-eld, robinhood-eld, sr-eld, speedline-eld, eld-2-go, captain-eld, ironman-eld, powertrucks-eld, paragon-eld, youlog-eld, legacy-eld, master-eld, monarch-tracking, motive, mountain-eld, omnitracs-es, omnitracs-xrs, omnitracs, one-step-gps, optima-eld, pro-ride-eld, pti-eld, real-eld, right-trucking, roadstar, routemate, samsara, sandbox, sparkle-eld, tx-eld, surfsight, tfm-eld, transflo, truckx, tt-eld, verizon-fleet, verizon-reveal, verizon, webfleet, xeld, xplore-eld, zonar, geotab-att, zippy-eld, evo-eld, ontime-eld, intelli-shift, id-eld, max-eld, asrit-solutions, smartelds, eld-books, vulcansols, motion-eld, blue-horse-eld, apex-ultima, radical-eld, rock-eld, lytx, blue-ink, utech, light-and-travel-eld, lion-eight, pop-eld, netradyne, people-net The name of the Telematics Service Provider.
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.
An optional ID from your system that can be used to reference connections.
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.
An optional list of tags from your system that can be used to reference connections.
The URL to send your user to in order to have them re-authenticate the connection.
Cursor used for pagination.
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"
]
},
"status": "connected",
"options": {
"ingestHistoryFromSourceSystem": true
},
"provider": {
"code": "geotab",
"name": "Geotab"
},
"externalId": "1234",
"sourceId": "123456789",
"syncMode": "automatic",
"token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
"tags": [
"Tag Name"
],
"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"
}