> ## Documentation Index > Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt > Use this file to discover all available pages before exploring further. # List bank accounts > Returns a list of bank accounts for the specified business. ## OpenAPI ````yaml get /v1/businesses/{businessId}/bank-accounts openapi: 3.0.1 info: title: API version: latest servers: [] security: - BearerAuth: [] tags: [] externalDocs: url: / paths: /v1/businesses/{businessId}/bank-accounts: get: tags: [] summary: List bank accounts description: Returns a list of bank accounts for the specified business. operationId: bank-accounts.list parameters: - name: Content-Type in: header description: Content-Type must be set to application/json. schema: type: string - name: businessId in: path description: The UUID of the business. required: true schema: type: string format: uuid - name: include_archived in: query required: false schema: type: boolean description: >- When true, archived bank accounts are included in the response. Defaults to false. responses: '200': description: '' content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ApiBankAccount' required: - data deprecated: false components: schemas: ApiBankAccount: type: object description: >- A bank account belonging to a business. Bank accounts are the top-level container that groups one or more external accounts (connected financial accounts) under a single logical account. properties: type: type: string description: Resource type. Value will be `Bank_Account`. example: Bank_Account id: type: string format: uuid description: Unique identifier for the bank account. account_name: type: string nullable: true description: User-defined display name for the bank account. example: Business Checking ledger_account_id: type: string format: uuid description: ID of the ledger account associated with this bank account. notes: type: string nullable: true description: Free-form notes about the bank account. institution: allOf: - $ref: '#/components/schemas/ApiFinancialInstitution' nullable: true description: The financial institution associated with this bank account. account_type: $ref: '#/components/schemas/AccountType' description: The broad category of the bank account. account_subtype: $ref: '#/components/schemas/AccountSubtype' description: The specific subtype of the bank account. notify_when_disconnected: type: boolean description: >- Whether to send a notification when any external account linked to this bank account becomes disconnected. is_disconnected: type: boolean description: Whether any linked external account is currently disconnected. archived_at: type: string format: date-time nullable: true description: >- Timestamp when the bank account was archived. Null if the account is active. external_accounts: type: array items: $ref: '#/components/schemas/ApiExternalAccount' description: >- List of external accounts (connected financial accounts) linked to this bank account. entity_tags: type: array items: $ref: '#/components/schemas/ApiTag' description: Tags applied to this bank account. memo: type: string nullable: true description: Internal memo for the bank account. metadata: type: object nullable: true description: >- Arbitrary platform-defined metadata associated with the bank account. reference_number: type: string nullable: true description: A platform-defined reference number for the bank account. required: - id - ledger_account_id - account_type - account_subtype - notify_when_disconnected - is_disconnected - external_accounts - entity_tags ApiFinancialInstitution: type: object properties: id: type: string format: uuid description: Unique identifier for the financial institution. name: type: string description: Name of the financial institution. example: Chase logo: type: string nullable: true description: Base64-encoded logo image for the financial institution. required: - id - name AccountType: type: string enum: - DEPOSITORY - CREDIT - LOAN - BROKERAGE - INVESTMENT description: The broad category of a bank account. AccountSubtype: type: string enum: - _401A - _401K - _403B - _457B - _529 - BROKERAGE - CASH_ISA - CRYPTO_EXCHANGE - EDUCATION_SAVINGS_ACCOUNT - EBT - FIXED_ANNUITY - GIC - HEALTH_REIMBURSEMENT_ARRANGEMENT - HSA - ISA - IRA - LIF - LIFE_INSURANCE - LIRA - LRIF - LRSP - NON_CUSTODIAL_WALLET - NON_TAXABLE_BROKERAGE_ACCOUNT - OTHER - OTHER_INSURANCE - OTHER_ANNUITY - PRIF - RDSP - RESP - RLIF - RRIF - PENSION - PROFIT_SHARING_PLAN - RETIREMENT - ROTH - ROTH_401K - RRSP - SEP_IRA - SIMPLE_IRA - SIPP - STOCK_PLAN - THRIFT_SAVINGS_PLAN - TFSA - TRUST - UGMA - UTMA - VARIABLE_ANNUITY - CREDIT_CARD - PAYPAL - CD - CHECKING - SAVINGS - MONEY_MARKET - PREPAID - AUTO - BUSINESS - COMMERCIAL - CONSTRUCTION - CONSUMER - HOME_EQUITY - LOAN - MORTGAGE - OVERDRAFT - LINE_OF_CREDIT - STUDENT - CASH_MANAGEMENT - KEOGH - MUTUAL_FUND - RECURRING - REWARDS - SAFE_DEPOSIT - SARSEP - PAYROLL - 'NULL' - ENUM_UNKNOWN description: The specific subtype of a bank account. ApiExternalAccount: type: object properties: type: type: string description: Resource type. Value will be `External_Account`. example: External_Account id: type: string format: uuid description: Unique identifier for the external account. external_account_external_id: type: string description: >- Unique ID of the external account in an external system for linking and idempotency. example: 0Br385JmgbTryJn8nEBnUb4A5ydv06U9Vbqqq external_account_source: $ref: '#/components/schemas/TransactionSource' description: Source of the external account. external_account_name: type: string description: Name of the external account. example: My external bank account latest_balance_timestamp: $ref: '#/components/schemas/ApiBalanceTimestamp' description: The latest balance timestamp. current_ledger_balance: type: integer format: int64 description: Current ledger balance of the external account in cents. uncategorized_transaction_sum: type: integer format: int64 description: >- Sum of uncategorized transactions for this external account in cents. mask: type: string nullable: true description: Last 4 digits of the external account number. example: '4321' institution: $ref: '#/components/schemas/ApiExternalAccountInstitution' description: The institution that the external account is associated with. notifications: type: array items: $ref: '#/components/schemas/ApiExternalAccountNotification' description: List of notifications for this external account. connection_needs_repair_as_of: type: string format: date-time nullable: true description: Timestamp indicating when the connection started needing repair. reconnect_with_new_credentials: type: boolean description: Whether the connection requires reconnection with new credentials. requires_user_confirmation_as_of: type: string format: date-time nullable: true description: Timestamp indicating when user confirmation was required. connection_id: type: string format: uuid nullable: true description: Unique identifier for the connection. connection_external_id: type: string nullable: true description: External identifier for the connection. user_created: type: boolean description: Whether this external account was created by a user. is_syncing: type: boolean description: >- Whether the external account is currently syncing. This status is based on the historical update status of the business's Plaid Item or Plaid Processor Token, which progresses through the following stages: - `NOT_READY`: Plaid has not provided any data yet. - `INITIAL_UPDATE_COMPLETE`: Plaid has pulled the first 30 days of transactions. - `HISTORICAL_UPDATE_COMPLETE`: Plaid has pulled the full 2 years of transactions. `is_syncing` is `true` until the Plaid Item or Processor Token reaches `HISTORICAL_UPDATE_COMPLETE`, at which point it becomes `false`. **Note:** In the Plaid Sandbox environment, the Plaid Item or Processor Token always skips directly to `HISTORICAL_UPDATE_COMPLETE`, so `is_syncing` will typically be `false` for sandbox data. ledger_account_id: type: string format: uuid nullable: true description: >- The ID of the [ledger account](https://docs.layerfi.com/api-reference/ledger/chart#ledger-account-object) associated with the external account. archived_at: type: string format: date-time nullable: true description: Timestamp when the external account was archived. show_transactions_on_or_after: type: string format: date-time nullable: true description: >- If set, only transactions on or after this timestamp are visible. Transactions before this date are hidden from user-facing views and API queries. When this value is set or moved forward, any categorized transactions that fall outside the new bounds are automatically uncategorized. show_transactions_on_or_before: type: string format: date-time nullable: true description: >- If set, only transactions on or before this timestamp are visible. Transactions after this date are hidden from user-facing views and API queries. When this value is set or moved backward, any categorized transactions that fall outside the new bounds are automatically uncategorized. ApiTag: type: object properties: id: type: string format: uuid description: ID for the tag. key: type: string description: Key for the tag. example: ExampleTagKey dimension_display_name: type: string nullable: true description: Display name for the tag dimension. value: type: string description: Value for the tag. example: ExampleTagValue value_display_name: type: string nullable: true description: Display name for the tag value definition. dimension_id: type: string format: uuid description: ID of the tag dimension this tag belongs to. definition_id: type: string format: uuid description: ID of the tag value definition. archived_at: type: string format: date-time nullable: true description: When the tag was archived. required: - id - key - value - dimension_id - definition_id TransactionSource: type: string enum: - UNIT - PLAID - API - STRIPE - CUSTOM ApiBalanceTimestamp: type: object properties: external_account_external_id: type: string description: >- Unique ID of the external account in an external system for linking and idempotency. example: 0Br385JmgbTryJn8nEBnUb4A5ydv06U9Vbqqq external_account_source: $ref: '#/components/schemas/TransactionSource' description: Source of the external account. balance: type: integer format: int64 description: The current balance of the bank account, in cents. at: type: string format: date-time description: The time the balance was recorded. created_at: type: string format: date-time description: When the balance timestamp was created. ApiExternalAccountInstitution: type: object properties: name: type: string description: The name of the institution for the external account. example: Bank of Generica logo: type: string nullable: true description: The logo of the institution for the external account in base 64. example: iVBORw0KGgoAAAANSUhEUgAAAJgAAACYCAMAAAAvHNATAAAAYFBMVEUAAAAAC1ETC ApiExternalAccountNotification: type: object properties: type: $ref: '#/components/schemas/ApiExternalAccountNotificationType' description: Type of notification. scope: $ref: '#/components/schemas/ApiExternalAccountNotificationScope' description: Scope of the notification. required: - type description: Notification for external account requiring user attention. ApiExternalAccountNotificationType: type: string enum: - OPENING_BALANCE_MISSING - CONFIRM_RELEVANT - CONFIRM_UNIQUE description: Type of notification for external account. ApiExternalAccountNotificationScope: type: string enum: - USER description: Scope of the external account notification. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````