Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Token returned by the authentication flow. Public tokens are one time use and expire after they are exchanged for a long-lived connection token.
"pub_tkn_9jNzH26e5b9RgErDnRt8zfm5emDUUyyG"
Response
OK
"conn_01GV12VR4DJP70GD1ZBK0SDWFH"
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
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"
- Omnitracs Options
- Omnitracs ES Options
- Omnitracs XRS Options
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}"
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