GET
/
connections
/
current

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Response

200 - application/json
id
string
required
company
object
required
token
string
required

This token is used when interacting with a connections' data.

status
enum<string>
required

Enum values:

  • connected: active and authenticated connection
  • disconnected: connection is no longer authenticated - please ask your user to link the account again
  • archived: connection has been archived from view - attempts to re-connect will cause us to check the connection status again
Available options:
connected,
disconnected,
archived
provider
object
required
sourceId
string

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.

externalId
string

An optional ID from your system that can be used to reference connections.

tags
string[]
syncMode
enum<string>
default: automaticrequired

Enum values:

  • automatic: Terminal will keep this connections data up to date
  • manual: Terminal will only sync data upon request
Available options:
automatic,
manual
linkUrl
string

The URL to send your user to in order to have them re-authenticate the connection.

lastSync
object

An object containing the state of a sync job. This can be polled after connection linking to know when data is available for ingestion.

createdAt
string
required
updatedAt
string
required