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

# Retrieve the bank accounts.



## OpenAPI

````yaml api-reference/openapi.json get /api/banking/accounts
openapi: 3.0.0
info:
  title: Bigcapital
  description: Financial accounting software
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/banking/accounts:
    get:
      tags:
        - Bank Accounts
      summary: Retrieve the bank accounts.
      operationId: BankAccountsController_getBankAccounts
      parameters:
        - name: customViewId
          required: false
          in: query
          description: Custom view ID
          schema:
            type: number
            example: 1
        - name: filterRoles
          required: false
          in: query
          description: Filter roles array
          schema:
            type: array
            items:
              type: string
        - name: columnSortBy
          required: false
          in: query
          description: Column to sort by
          schema:
            example: created_at
            type: string
        - name: sortOrder
          required: false
          in: query
          description: Sort order
          schema:
            example: DESC
            enum:
              - DESC
              - ASC
            type: string
        - name: stringifiedFilterRoles
          required: false
          in: query
          description: Stringified filter roles
          schema:
            example: '{"fieldKey":"status","value":"active"}'
            type: string
        - name: searchKeyword
          required: false
          in: query
          description: Search keyword
          schema:
            example: bank account
            type: string
        - name: viewSlug
          required: false
          in: query
          description: View slug
          schema:
            example: active-accounts
            type: string
        - name: page
          required: false
          in: query
          description: Page number
          schema:
            minimum: 1
            example: 1
            type: number
        - name: pageSize
          required: false
          in: query
          description: Page size
          schema:
            minimum: 1
            example: 25
            type: number
        - name: inactiveMode
          required: false
          in: query
          description: Include inactive accounts
          schema:
            default: false
            example: false
            type: boolean
      responses:
        '200':
          description: List of bank accounts retrieved successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BankAccountResponseDto'
components:
  schemas:
    BankAccountResponseDto:
      type: object
      properties:
        id:
          type: number
          description: The unique identifier of the account
          example: 1
        name:
          type: string
          description: The name of the account
          example: Cash Account
        slug:
          type: string
          description: The slug of the account
          example: cash-account
        code:
          type: string
          description: The code of the account
          example: '1001'
        accountType:
          type: string
          description: The type of the account
          example: bank
        parentAccountId:
          type: number
          description: The parent account ID
          example: null
        currencyCode:
          type: string
          description: The currency code of the account
          example: USD
        active:
          type: boolean
          description: Whether the account is active
          example: true
        bankBalance:
          type: number
          description: The bank balance of the account
          example: 5000
        bankBalanceFormatted:
          type: string
          description: The formatted bank balance
          example: $5,000.00
        lastFeedsUpdatedAt:
          type: object
          description: The last feeds update timestamp
          example: '2024-03-20T10:30:00Z'
        lastFeedsUpdatedAtFormatted:
          type: string
          description: The formatted last feeds update timestamp
          example: Mar 20, 2024 10:30 AM
        lastFeedsUpdatedFromNow:
          type: string
          description: The last feeds updated from now (relative time)
          example: 2 hours ago
        amount:
          type: number
          description: The amount of the account
          example: 5000
        formattedAmount:
          type: string
          description: The formatted amount
          example: $5,000.00
        plaidItemId:
          type: string
          description: The Plaid item ID
          example: plaid-item-123
        plaidAccountId:
          type: string
          description: The Plaid account ID
          example: plaid-account-456
        isFeedsActive:
          type: boolean
          description: Whether the feeds are active
          example: true
        isSyncingOwner:
          type: boolean
          description: Whether the account is syncing owner
          example: true
        isFeedsPaused:
          type: boolean
          description: Whether the feeds are paused
          example: false
        accountNormal:
          type: string
          description: The account normal
          example: debit
        accountNormalFormatted:
          type: string
          description: The formatted account normal
          example: Debit
        flattenName:
          type: string
          description: The flatten name with all dependant accounts names
          example: 'Assets: Cash Account'
        accountLevel:
          type: number
          description: The account level in the hierarchy
          example: 2
        createdAt:
          format: date-time
          type: string
          description: The creation timestamp
          example: '2024-03-20T10:00:00Z'
        updatedAt:
          format: date-time
          type: string
          description: The update timestamp
          example: '2024-03-20T10:30:00Z'
      required:
        - id
        - name
        - slug
        - code
        - accountType
        - parentAccountId
        - currencyCode
        - active
        - bankBalance
        - bankBalanceFormatted
        - lastFeedsUpdatedAt
        - lastFeedsUpdatedAtFormatted
        - lastFeedsUpdatedFromNow
        - amount
        - formattedAmount
        - plaidItemId
        - plaidAccountId
        - isFeedsActive
        - isSyncingOwner
        - isFeedsPaused
        - accountNormal
        - accountNormalFormatted
        - flattenName
        - accountLevel
        - createdAt
        - updatedAt

````