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

# List connected bank accounts

> Returns active bank-feed accounts connected to the organization. Pass `includeHidden=true` to also return hidden accounts, which are otherwise excluded from every surface except the connection settings that unhide them. `connecting` lists banks still signing in or pulling for the first time, which have no accounts yet. This is read-only; hiding and disconnecting accounts are available only in the signed-in web app.



## OpenAPI

````yaml /openapi.json get /api/bank-accounts
openapi: 3.1.0
info:
  title: Equated API
  version: 1.0.0
  description: >-
    Agent-facing accounting API. Authenticate with a bearer token issued from
    Settings → API Tokens, or via the in-app session cookie when called from the
    web client.
servers:
  - url: https://app.equated.co
    description: API server
security: []
paths:
  /api/bank-accounts:
    get:
      tags:
        - Bank Accounts
      summary: List connected bank accounts
      description: >-
        Returns active bank-feed accounts connected to the organization. Pass
        `includeHidden=true` to also return hidden accounts, which are otherwise
        excluded from every surface except the connection settings that unhide
        them. `connecting` lists banks still signing in or pulling for the first
        time, which have no accounts yet. This is read-only; hiding and
        disconnecting accounts are available only in the signed-in web app.
      parameters:
        - schema:
            type: boolean
            nullable: true
          required: false
          name: includeHidden
          in: query
      responses:
        '200':
          description: Connected bank accounts
          content:
            application/json:
              schema:
                type: object
                properties:
                  accounts:
                    type: array
                    items:
                      $ref: '#/components/schemas/BankAccount'
                  connecting:
                    type: array
                    items:
                      $ref: '#/components/schemas/ConnectingBank'
                required:
                  - accounts
                  - connecting
      security:
        - bearerAuth: []
components:
  schemas:
    BankAccount:
      type: object
      properties:
        id:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        name:
          type: string
        officialName:
          type: string
          nullable: true
        type:
          type: string
        subtype:
          type: string
          nullable: true
        mask:
          type: string
          nullable: true
        currentBalance:
          type: string
          nullable: true
        availableBalance:
          type: string
          nullable: true
        booksBalance:
          type: string
          nullable: true
        isoCurrencyCode:
          type: string
          nullable: true
        institutionName:
          type: string
        institutionLogo:
          type: string
          nullable: true
        institutionUrl:
          type: string
          nullable: true
        syncError:
          type: object
          nullable: true
          properties:
            message:
              type: string
            lastFailedAt:
              type: string
          required:
            - message
            - lastFailedAt
        isSyncing:
          type: boolean
        connectionId:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
        provider:
          type: string
          nullable: true
          enum:
            - plaid
            - quiltt
            - equated
            - null
        integrationId:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
        integrationKind:
          type: string
          nullable: true
          enum:
            - humi
            - shopify
            - shopify_merchant
            - quickbooks
            - quickbooks_payroll
            - gmail
            - mercury
            - payworks
            - square
            - etsy
            - stripe
            - null
        quilttConnectionId:
          type: string
          nullable: true
        equatedBank:
          type: string
          nullable: true
          enum:
            - venn
            - null
        status:
          type: string
          enum:
            - active
            - hidden
            - deleted
      required:
        - id
        - name
        - officialName
        - type
        - subtype
        - mask
        - currentBalance
        - availableBalance
        - booksBalance
        - isoCurrencyCode
        - institutionName
        - institutionLogo
        - institutionUrl
        - syncError
        - isSyncing
        - connectionId
        - provider
        - integrationId
        - integrationKind
        - status
    ConnectingBank:
      type: object
      properties:
        connectionId:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        institutionName:
          type: string
        institutionLogo:
          type: string
          nullable: true
        institutionUrl:
          type: string
          nullable: true
        provider:
          type: string
          enum:
            - plaid
            - quiltt
            - equated
        phase:
          type: string
          enum:
            - signing_in
            - fetching_accounts
            - syncing_transactions
      required:
        - connectionId
        - institutionName
        - institutionLogo
        - institutionUrl
        - provider
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token issued from the Equated app under Settings → API Tokens.

````