---
title: "List BankAccounts"
method: GET
path: "/bank_accounts"
tags: ["Bank Accounts"]
---

# List BankAccounts

`GET /bank_accounts`

## Request

- Base URL: `https://api.upflow.io/v1`
- URL: `https://api.upflow.io/v1/bank_accounts`
- Auth: API key in header `X-Api-Key` and API key in header `X-Api-Secret`

List bank accounts with optional filtering.

## Query parameters

- `offset` integer
- `page` integer
- `limit` integer

## Response `200`

Paginated list of bank accounts.

- object
  - `offset` integer: 0-based index of the first item returned. Returned when using offset-based pagination or by default.
  - `page` integer: Page number (1-based). Returned when using page-based pagination.
  - `limit` integer, required: Maximum number of items returned.
  - `total` integer, required: Total items in the set.
  - `items` BankAccount[], required
    - `id` string, uuid, required: The ID of the bank account.
    - `externalId` string: Bank account external ID.
    - `alias` string: Descriptive name of the bank account.
    - `currency` 'EUR' | 'CHF' | 'USD' | 'CAD' | 'GBP', required: ISO 4217 Currency Code
    - `source` string: Source of the bank account information.
    - `swift` string, required: The SWIFT/BIC code of the bank.
    - `accountNumber` string, required: The bank account number or IBAN for European accounts.
    - `routingNumber` string: The routing transit number for the bank account. Required for US accounts, but optional for European accounts.
    - `bankName` string: The name of the bank.
    - `isMain` boolean, required: Indicates if it's the main bank account that should be displayed by default on the customer portal.
    - `region` 'EU' | 'US': The region of the bank account: `EU` or `US`.
    - `createdAt` string, date-time: The date at which the bank account was created (ISO 8601 format).

---

[API](https://skmtc.dev/upflow/apis/upflow-api.md) - [All operations](https://skmtc.dev/upflow/apis/upflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upflow/apis/upflow-api/revisions/898a98ca0587?raw)