List accounts

get

https://api.sandbox.ibanq.com/v1/accounts

Retrieves a paginated list of accounts owned by every member of the caller's auth group (and their active direct sub-accounts), optionally filtered to a single member via clientId. clientName and accountName match as case-insensitive substrings; accountNumber and iban match exactly, but also case-insensitively.

Query Params

accountId

string | null

Filter to a single account by its id

clientId

string | null

Optional; when present must name a member of the caller's group and scopes the results to that member alone

clientName

string | null

Filter to accounts whose owning client name contains this value

accountName

string | null

Filter to accounts whose name contains this value

accountNumber

string | null

Filter to accounts with this exact account number

iban

string | null

Filter to accounts with this exact IBAN

parentClientId

string | null

Filter to accounts whose owning client's parent is this client id

includeClosed

boolean

Include closed accounts (default false)

includeBalances

boolean

Include per-currency balances (default false). A currency account appears once it has ledger activity, so a newly provisioned account, or one whose first credit is still being processed, returns an empty balances array rather than a zero balance

pageNumber

int32

1-based page number (default 1, max 100000)

pageSize

int32

Page size, 1-200 (default 50)

orderBy

string

enum

Sort key: clientName, accountNumber, iban, parentName (default clientName)

Allowed:

orderDirection

string

enum

Sort direction: asc, desc (default asc)

Allowed:

Headers

DPoP

string

required

Fresh RFC 9449 proof JWT (ES256) signed with the client's DPoP key, binding this request's method and URL to the access token; generate a new proof per request

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Paginated list of accounts

400Invalid request parameters

403clientId does not match a client this credential may act for

500Internal server error

504The request timed out before a response could be produced.