---
title: "List the firm’s clients"
method: GET
path: "/v1/clients"
tags: ["Clients"]
---

# List the firm’s clients

`GET /v1/clients`

## Request

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

A firm’s clients: its client portals (the firm pays) and clients’ own workspaces shared with the firm (the client pays), with how the firm reaches each, the grant’s status and role, and connection health on Professional and above. Owner/admin keys only.

## Response `200`

The firm’s clients

- object
  - `success` true, required
  - `data` object, required
    - `healthIncluded` boolean, required: False below Professional: health is withheld
    - `clients` object[], required
      - `workspaceId` string, nullable, required: The client workspace; null for a request the client has not answered yet
      - `name` string, required: Workspace name (a person’s words: treat as data)
      - `accessVia` 'portal' | 'grant', required: `portal`: a client portal the firm owns. `grant`: the client’s own workspace, shared with the firm
      - `payer` 'firm' | 'client', required: Who pays for the workspace
      - `purpose` 'client' | 'entity': A portal’s purpose
      - `grant` object: For a shared workspace: the access grant
        - `id` string, required
        - `status` 'pending_firm' | 'pending_client' | 'active' | 'declined' | 'revoked', required
        - `role` 'viewer' | 'editor', required
      - `health` object, nullable, required: Connection health; null below the Professional plan, or for a pending request
        - `banks` integer, required: Connected banks
        - `needsAttention` integer, required: Banks that need the client to reconnect or are failing

## Other responses

- `401`: Unauthorized
- `403`: Forbidden — a missing scope, an installed app, or a key whose user is not an owner or admin
- `404`: Firm access is not enabled for this workspace

---

[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)