---
title: "List bank connections"
method: GET
path: "/v1/banks"
tags: ["Banks"]
---

# List bank connections

`GET /v1/banks`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/banks`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

List banks owned by the current workspace. Pass `?scope=family` to include banks from every portal under this workspace — useful for accountants who want a single view across all client portals. Family scope requires admin+ role and is only valid on a top-level workspace.

## Query parameters

- `scope` 'self' | 'family': Resource scope. `self` (default) returns this workspace only. `family` returns this workspace plus every live portal under it; each row gains a `portal: { id, name, icon } | null` badge and a `workspaceId` field. Admin+ only; top-level workspaces only.

## Response `200`

List of banks. When `scope=family`, each row additionally carries `workspaceId` and `portal`.

- object
  - `success` true, required
  - `data` object[], required
    - `id` string, required
    - `name` string, required
    - `source` 'plaid' | 'snaptrade' | 'saltedge' | 'fiskil' | 'quiltt', required
    - `type` string, required
    - `order` number, required
    - `icon` string
    - `connectionStatus` object
      - `connected` boolean
      - `status` string
      - `errorCode` string
      - `errorMessage` string
      - `lastCheckedAt` string
      - `source` 'provider_call' | 'webhook' | 'reconciler' | 'user'
    - `institutionId` string
    - `createdAt` string, required
    - `updatedAt` string, required
    - `links` object, required

## Other responses

- `400`: Invalid `scope` value, or `scope=family` was requested against a portal workspace
- `401`: Unauthorized
- `403`: Forbidden — `scope=family` requires admin+ role

---

[API](https://skmtc.dev/banksync/apis/banksync-api.md) · [All operations](https://skmtc.dev/banksync/apis/banksync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/banksync/apis/banksync-api/revisions/94465f5ee922?raw)