Skip to main content
GET
List your users' financial connections

Authorizations

Authorization
string
header
required

Username = your client id. Password = your client secret.

So the base64-encoded username:password described below is client_id:client_secret:

Most HTTP clients build that header for you:

Both values come from Developers → Apps → your app. The secret is shown once at creation and is prefixed oac_.

Query Parameters

user_id
string

One of your users, by the id this API gave you.

Maximum string length: 64
external_user_id
string

One of your users, by your own correlation id.

Maximum string length: 255
status
enum<string>

The lifecycle status of a financial connection, the same for every provider.

Available options:
PENDING_AUTHORIZATION,
CONNECTED,
DISABLED,
REVOKED,
EXPIRED,
ERROR
provider
enum<string>

The provider a financial connection or account is sourced from: GOCARDLESS (EU/UK banks), AKAHU (NZ banks), ARRAY (US banks), SNAPTRADE (brokerages and crypto exchanges) or DEMO (Synci's demo banks). UNKNOWN is used for accounts created manually via the API.

Available options:
UNKNOWN,
GOCARDLESS,
AKAHU,
ARRAY,
SNAPTRADE,
DEMO
enabled
boolean
expiring_within_days
integer

Connections whose bank consent lapses within N days — the re-consent sweep. GoCardless only; other providers never expire.

Required range: 0 <= x <= 365
per_page
integer
Required range: 1 <= x <= 200
page
integer
Required range: x >= 1

Response

Paginated set of ManagedConnectionResource

data
ManagedConnectionResource · object[]
required
meta
object
required