Banks

List bank connections

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.

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

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

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

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.