Returns every bank Connection for the user, each with nested accounts. Use get_bank_connection for one connection. Pass an account’s accountId to link_account (source: "bank"). OAuth connect / sync-now stays in-app.
GET
/v1/list_bank_connectionsQuery
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| (none) | — | — | — | No parameters. |
Response data
| Field | Type | Description |
|---|---|---|
| items | array | Bank connections owned by the authenticated user. |
Item fields
| Field | Type | Description |
|---|---|---|
| connectionId | string | Bank connection id. |
| institutionLabel | string | Display name of the linked institution. |
| status | string | Connection lifecycle status (active, error, paused). |
| provider | string | Aggregator provider id (e.g. pluggy, lunchflow). |
| region | string | Connection region bucket (br or other). |
| needsInitialSync | boolean | True while the first full sync is still running. |
| accounts | array | Snapshot accounts under this connection (see nested fields). |
| accounts[].accountId | string | Pass to link_account with source bank (same role as investment groupId). |
| accounts[].name | string | Account display label (custom name or kind index). |
| accounts[].accountKind | string | checking or credit. |
| accounts[].kindIndex | number | Index among accounts of the same kind on this connection. |
| accounts[].balance | number | Latest synced balance. |
| accounts[].currency | string | ISO 4217 currency code for the balance. |