Get Current Connection
Get the details of the current active connection. The current connection is derived from the provided connection token.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The token returned when a user authenticated their account. This authorizes access to a specific account.
Response
The connection your application has with your customer's TSP.
This token is used when interacting with a connections' data.
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 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 ID 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.
An object containing the state of a sync job. This can be polled after connection linking to know when data is available for ingestion.