Skip to main content
GET
Get connections
Learn more:
  • What is a connection? ↗
  • How to connect to a software? ↗
  • How to handle activation and redirects? ↗

Path Parameters

consumer_id
string<uuid>
required

Response

Successful Response

connectionid
string<uuid>
required
name
string
required
integration
string
required
integrationid
integer
required
api
string
required
status
enum<string>
required
Available options:
active,
inactive
data
Data · object | null
agent
LocalAgentInfo · object | null

For local agent only. Indicates whether the local agent is up and running

datalayer
enum<string> | null

State of the datalayer for this connection. Null when the datalayer does not apply: the connection is inactive, its API has no datalayer, or the datalayer is not set up for that API on your account. Resolved per API, so every connection of the same API on a consumer reports the same value. ready when reads can be served from the datalayer (x-chift-datalayer header). syncing when the datalayer is enabled but its first sync has not finished, so there is nothing to query yet. not_enabled when the datalayer is available for this API but not turned on for this consumer.

Available options:
not_enabled,
syncing,
ready