Skip to main content
GET
List all financial accounts

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

omit_sensitive_identifiers
boolean

Omit sensitive financial account/card number identifiers, and certain direct identifiers from the response. Currently, the following fields will be omitted: iban, bban, scan, owner_name, owner_address, bic, msisdn, account_number_masked, integrator_id, institution_id.

page[size]
integer
default:25

The number of results that will be returned per page.

page[number]
integer

The page number to start the pagination from.

filter[id]
string
filter[name]
string
filter[display_name]
string
filter[enabled]
string
filter[financial_connection_id]
string
filter[bban]
string
filter[iban]
string
filter[institution_config_id]
string
filter[bic]
string
filter[currency]
string
filter[product_name]
string
filter[source_type]
string
filter[integrator_id]
string
filter[institution_id]
string
filter[account_category]
string

Filter by the account's category or provider. Accepts a single value or comma-separated list: ?filter[account_category]=BANK|INVESTMENT|DEPOSIT|LOC ?filter[integrator]=GOCARDLESS|AKAHU|SNAPTRADE

filter[integrator]
string
filter[category]
string

Filter by the institution's category — distinguishes crypto exchanges (e.g. Coinbase, Kraken) from regular brokerages. ?filter[category]=CRYPTO → only crypto-exchange accounts ?filter[category]=BROKERAGE → only brokerage accounts

filter[domain]
string

Filter by data domain: bank returns bank accounts (including demo banks), asset returns investment, brokerage and crypto accounts. The account's own category decides for providers that serve both kinds on one connection.

sort
enum<string>[]
Available options:
id,
-id,
name,
-name,
display_name,
-display_name,
bban,
-bban,
iban,
-iban,
last_synced_at,
-last_synced_at,
created_at,
-created_at,
updated_at,
-updated_at
include
enum<string>[]
Available options:
rules,
transfer_links,
transfer_links_count,
financial_connection,
financial_connection.institution

Response

Paginated set of FinancialAccountResource

data
FinancialAccountResource · object[]
required
meta
object
required