Skip to main content
GET
Get Connect Connection

Authorizations

X-API-Key
string
header
required

Path Parameters

connection_id
string<uuid>
required

Query Parameters

client_user_id
string | null
Required string length: 1 - 160

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
institution_id
string<uuid>
required
client_user_id
string
required
environment
enum<string>
required
Available options:
test,
live
status
enum<string>
required
Available options:
active,
login_required,
revoked,
error
created_at
string<date-time>
required
institution
ConnectInstitutionRead · object
required
last_synced_at
string<date-time> | null
revoked_at
string<date-time> | null
updated_at
string<date-time> | null
latest_sync
ConnectSyncRunRead · object | null