API reference

Accounts

Get a connect session

Polls a connect session. Once status is completed, the accounts array lists what was connected.

Required permission: `connections:read`

Accepts `profileId` to target a specific profile. Omit it to use the key’s home profile.

GET/v1/connect/sessions/{id}connections:read

Request

Authorization

Send your API key as a Bearer token in the Authorization header.

Path parameters

idstringrequired

Connect session id.

Query parameters

profileIdstringoptional

Profile to act on. Defaults to the profile the API key was created in.

Response

Returns 200.

ConnectSessionrequired
Account[]required

Errors

Failures use the standard error format.

StatusCodeWhen it happens
401invalid_api_keyThe key does not exist, was revoked, or is malformed. Keys start with cdyn_live_.
403profile_not_accessibleThe requested profile is outside this key’s scope, or belongs to another account.
404not_foundThe resource does not exist inside the resolved profile.
429rate_limit_exceededToo many requests for this key. Honour the Retry-After header before retrying.
500internal_errorSomething failed on our side. Retry with the same Idempotency-Key; report the requestId if it persists.