> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trycherry.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List connected bank accounts

> Every bank account the tenant has connected — Plaid-linked and manual — with its institution, currency, kind, balances, and whether it is mapped to a ledger account. `derivedBalance` (opening balance rolled forward through settled transactions) is the current figure for manual accounts; Plaid accounts report `currentBalance` instead. Small enough to return whole; not paginated.



## OpenAPI

````yaml /openapi.json get /bank-accounts
openapi: 3.0.3
info:
  title: Cherry API
  version: 1.0.0
  description: >-
    Cherry's public developer API — programmatic access to a business's books as
    Cherry keeps them: bank transactions with their categorizations, the chart
    of accounts, the double-entry journal, financial statements, legal entities,
    the tax-obligation calendar, and the fiscal health score.


    Authenticate every request with an API key: `Authorization: Bearer
    ck_live_…`. Keys are created in the Cherry app and are scoped to one
    business (tenant) — there is no tenant id in any URL. Keys carry a `read`
    and/or `write` scope; every GET needs `read`, mutations need `write`.


    Conventions: successful responses wrap the payload in `{ "data": … }`; list
    endpoints add `{ "meta": { "pagination": { limit, offset, nextOffset } } }`
    — pass `nextOffset` back as `offset` until it is null. Errors are `{
    "error": string, "reason"?: string }` with conventional status codes. Dates
    are `YYYY-MM-DD`; money amounts are numbers in the row's currency. Requests
    are rate-limited per key with token buckets (429 + `Retry-After` when
    exhausted); report generation has a smaller budget than plain reads.
servers:
  - url: https://api.trycherry.ai/v1
security:
  - bearerAuth: []
tags:
  - name: Transactions
    description: Bank feed rows and their categorizations.
  - name: Accounts
    description: The tenant's chart of accounts.
  - name: Bank accounts
    description: >-
      Connected bank accounts — Plaid-linked and manual. Manual institutions are
      how developers without a Plaid connection bring their own accounts and
      transactions.
  - name: Journal
    description: The double-entry journal (entries and lines).
  - name: Reports
    description: Trial balance and financial statements.
  - name: Entities
    description: Legal entities behind the tenant.
  - name: Obligations
    description: The tax/compliance calendar Cherry tracks.
  - name: Health
    description: Cherry's composite fiscal readiness score.
  - name: Meta
    description: The API's own machine-readable contract.
paths:
  /bank-accounts:
    get:
      tags:
        - Bank accounts
      summary: List connected bank accounts
      description: >-
        Every bank account the tenant has connected — Plaid-linked and manual —
        with its institution, currency, kind, balances, and whether it is mapped
        to a ledger account. `derivedBalance` (opening balance rolled forward
        through settled transactions) is the current figure for manual accounts;
        Plaid accounts report `currentBalance` instead. Small enough to return
        whole; not paginated.
      operationId: listBankAccounts
      parameters:
        - name: entityId
          in: query
          required: false
          description: >-
            Scope to one legal entity (UUID from GET /entities). Defaults to the
            tenant's primary entity.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The tenant's bank accounts
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BankAccount'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    BankAccount:
      type: object
      description: >-
        One connected bank account — Plaid-linked or manually created. Manual
        accounts carry a declared opening balance; `derivedBalance` rolls it
        forward through every settled transaction and is the figure to trust.
      properties:
        id:
          type: string
          format: uuid
          description: Cherry's internal bank-account id.
        externalAccountId:
          type: string
          description: >-
            For manual accounts, 'manual:<institution>:<external-id>'; for Plaid
            accounts, Plaid's opaque account id.
        institutionName:
          type: string
          nullable: true
        name:
          type: string
        currency:
          type: string
          description: ISO 4217, e.g. USD.
        kind:
          type: string
          nullable: true
          description: Account subtype, e.g. checking, savings, credit_card.
        type:
          type: string
          nullable: true
          description: Account type, e.g. depository, credit.
        openingBalance:
          type: number
          nullable: true
          description: Declared balance as of openingBalanceDate (manual accounts).
        openingBalanceDate:
          type: string
          format: date
          nullable: true
        derivedBalance:
          type: number
          nullable: true
          description: >-
            openingBalance rolled forward through settled transactions — what
            the account holds today. Null when no opening balance was declared.
        currentBalance:
          type: number
          nullable: true
          description: Last provider-reported balance (Plaid accounts).
        ledgerMapped:
          type: boolean
          description: >-
            Whether the account is mapped to a ledger account. Transactions on
            unmapped accounts are not booked to the General Ledger until mapped.
        ledgerAccountNumber:
          type: string
          nullable: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Stable machine-readable error code.
        reason:
          type: string
          description: Human-readable explanation.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ck_live_…
      description: >-
        Cherry API key, created in the app. Sent as `Authorization: Bearer
        ck_live_…`.

````