---
title: "Query bank accounts"
method: POST
path: "/v6/banks/accounts/query"
tags: ["Bank Accounts"]
---

# Query bank accounts

`POST /v6/banks/accounts/query`

Query bank accounts for the authenticated user

## Request body

- BankAccountQueryParam
  - `cursor` string, nullable — Cursor from the previous paginated response
  - `limit` integer — Page size, i.e. number of items to return per page
  - `sort` BankAccountSort — Sort order for the items in the response.
    - `orderBy` 'ID' | 'NAME' — Sort column
    - `direction` 'ASC' | 'DESC' — Sort direction. Defaults to DESC
  - `filter` BankAccountFilterParam — Filter for items in the response.
    - `status` BankAccountStatusListFilter — Status filter
      - `in` string[]
      - `notIn` string[]
      - `equal` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `notEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `greaterThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `greaterThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `lessThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `lessThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
    - `journalEntry` JournalEntryFilter — Journal entry filter
      - `expand` boolean
    - `integration` IntegrationFilter — Integration filter
      - `expand` boolean
    - `apiName` ApiNameListFilter
      - `in` string[]
      - `notIn` string[]
      - `equal` 'BOX' | 'CLOVER' | 'STRIPE' | 'PLAID' | 'KNOX' | 'UBER' | 'FRESHBOOKS' | 'HARVEST' | 'KW' | 'FRESHBOOKS2' | 'CAPITAL_ONE' | 'SQUARE' | 'DOTLOOP' | 'REALOGY' | 'UPWORK' | 'SHOPIFY' | 'DEDUCTR' | 'ENTERPRISE' | 'MOXIWORKS' | 'APPDIRECT' | 'LONEWOLF' | 'LONEWOLF_TRANSACTIONDESK' | 'SAMPLE_BANK' | 'TAXBOT' | 'GUSTO' | 'XERO' | 'UNIT' | 'MOOV' | 'QBO' | 'QUALPAY' | 'BENCH' | 'PARTNER_IMPLEMENTATION' | 'CHECK' | 'RUTTER' | 'WAVE' | 'MANUAL_ENTRY' | 'CSV_IMPORT' | 'ADYEN' | 'PAYABLI'
      - `notEqual` 'BOX' | 'CLOVER' | 'STRIPE' | 'PLAID' | 'KNOX' | 'UBER' | 'FRESHBOOKS' | 'HARVEST' | 'KW' | 'FRESHBOOKS2' | 'CAPITAL_ONE' | 'SQUARE' | 'DOTLOOP' | 'REALOGY' | 'UPWORK' | 'SHOPIFY' | 'DEDUCTR' | 'ENTERPRISE' | 'MOXIWORKS' | 'APPDIRECT' | 'LONEWOLF' | 'LONEWOLF_TRANSACTIONDESK' | 'SAMPLE_BANK' | 'TAXBOT' | 'GUSTO' | 'XERO' | 'UNIT' | 'MOOV' | 'QBO' | 'QUALPAY' | 'BENCH' | 'PARTNER_IMPLEMENTATION' | 'CHECK' | 'RUTTER' | 'WAVE' | 'MANUAL_ENTRY' | 'CSV_IMPORT' | 'ADYEN' | 'PAYABLI'

## Response `200`

Success

- PaginatedResponseBankAccountGetDto
  - `result` 'SUCCESS' | 'FAILURE' — The result of the action performed.
  - `data` BankAccountGetDto[] — The data generated by the action performed.
    - `id` string, required — Id of the account
    - `status` 'ACTIVE' | 'INACTIVE' | 'REMOVED', required — Status of the account
    - `apiName` 'PLAID' | 'UNIT' | 'STRIPE' | 'SHOPIFY' | 'SQUARE' | 'RUTTER' | 'UBER' | 'MOOV' | 'QUALPAY' | 'MANUAL_ENTRY' | 'CSV_IMPORT' | 'PARTNER_IMPLEMENTATION' | 'QBO' | 'XERO' | 'BENCH' | 'WAVE', required — Name of the API from which this transaction originated
    - `iconUrl` string, nullable, required — Icon URL for the bank account
    - `name` string, required — Display name for the bank account
    - `mask` string, nullable, required — Mask of the user's bank account, often the last 4 digits of the account number
    - `integration` IntegrationExpanded, nullable, required — Institution data for the bank account
      - `id` string, nullable — The id of the integration this account belongs to, if applicable
      - `apiInstitutionId` string, nullable — Id of the institution that the bank account or transaction originated from
    - `type` 'DEPOSITORY' | 'CREDIT' | 'EQUITY' | 'LOAN' | 'INVESTMENT' | 'OTHER', required — Type of the user's bank account
    - `subType` string, nullable, required — Sub-type of the user's bank account
    - `lastSyncedDate` string, date-time, nullable, required — Date of the last attempt to sync the account
    - `syncTransactions` boolean, required — Whether to sync transactions for this account
    - `isSupported` boolean, required — Whether the bank account type is supported
    - `tranStartDate` string, date, nullable, required — Earliest day for which to pull transactions
    - `tranMinStartDate` string, date, nullable, required — Earliest day for which transactions can be made available
    - `latestTransactionDate` string, date, nullable, required — Date of the most recent Tight transaction
    - `glAccountId` string, nullable, required — GL account id, referencing an account in the chart of accounts
    - `beginningBalanceData` BeginningBalanceDto, required — Beginning balance data for the bank account
      - `journalEntry` JournalEntryExpanded, nullable — The journal entry responsible for this beginning balance
        - `id` string, nullable, required — Id of the Journal Entry
        - `tranDate` string, date, nullable, required — Date this journal entry was created
      - `amount` integer, nullable — The beginning balance of this account
    - `accountBalance` integer, nullable, required — Balance of the bank account (in cents). If the account is present in Plaid's Accounts API, this will be the balance of that bank account as tracked by Plaid. Otherwise, this will be the balance of the bank account as tracked by Tight. If neither balance is available, this field will be null
  - `cursor` ResponseCursor — Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.
    - `after` string — After cursor - Fetches entities after this cursor. Useful for paging forwards.
    - `before` string — Before cursor - Fetches entities before this cursor. Useful for paging backwards.

## Other responses

- `400` — Bad request
- `401` — Not authenticated
- `403` — Not authorized
- `404` — Endpoint not found
- `500` — Internal server error

---

[API](https://skmtc.net/tight/apis/tight-api.md) · [All operations](https://skmtc.net/tight/apis/tight-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tight/tight-api/versions/e9f0790a89af/schema)
