Skip to main content
GET
List accounts

Authorizations

Authorization
string
header
required

OAuth 2.0 client_credentials grant. Send client_id:client_secret as HTTP Basic, or as form fields. Tokens are HS256 JWTs valid for one hour (configurable). Decode them at jwt.io.

Query Parameters

cursor
string

Opaque token from a prior page's next_cursor. Do not decode or construct cursors client-side; their encoding is implementation detail and may change between releases. Cursors are stable for the resources they reference (a cursor pointing at a deleted / anonymized resource still paginates correctly. It points at a position, not at a row). No documented TTL; treat cursors as valid until the next forward-incompatible API change.

limit
integer
default:50
Required range: 1 <= x <= 200
type
enum<string>

Filter by accounting type.

Available options:
asset,
liability,
revenue,
expense,
equity
currency
string

Filter by currency ticker.

kind
enum<string>

Filter by account_kind. Use kind=reserve to list reserve accounts, optionally narrowed by counterparty_ref.

Available options:
standard,
reserve
counterparty_ref
string

Filter by counterparty_ref (typically combined with kind=reserve).

fund_classification
enum<string>

Filter by fund_classification.

Available options:
client_held,
operator,
neutral
custody_provider
string

Filter to accounts tagged with this custody_provider.

Response

200 - application/json

A page of accounts

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
livemode
boolean
required
Example:

false

request_id
string
required
Example:

"req_3LhM8XKx9q4hQv"

next_cursor
string | null
total
integer | null

Present only when the caller passed ?include_total=true.