Create Connection
Create a new connection via API. This endpoint can be used to provide a completely custom connection creation experience for your customers.
For most use cases we recommend using the Link UI to create connections.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
geotab Enum values:
automatic: Terminal will keep this connections data up to datemanual: Terminal will only sync data upon request
automatic, manual Optional backfill to be requested upon successful connection. Will start from NOW if not provided.
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 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.
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 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.
ISO 8601 date
ISO 8601 date