List all accounts

{ "code": "ERR-0001", "detail": "Property foo is required but is missing.", "errors": [ { "location": "<string>", "message": "<string>", "value": "<unknown>" } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example", "upstream": { "code": "E4001", "message": "account not found at provider" } }

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id

string

required

Organization ID (UUID)

ledger_id

string

required

Ledger ID (UUID)

Query Parameters

metadata

string

JSON string to filter accounts by metadata fields

limit

string

Max items per page (1-100, default 10)

page

string

Page number (default 1)

start_date

string

Filter accounts created on/after this date (YYYY-MM-DD)

end_date

string

Filter accounts created on/before this date (YYYY-MM-DD)

sort_order

string

Sort direction (asc, desc)

portfolio_id

string

Filter accounts by portfolio ID (UUID)

segment_id

string

Filter accounts by segment ID (UUID)

status

string

Filter accounts by status (ACTIVE, INACTIVE, BLOCKED)

type

string

Filter accounts by type (e.g., deposit, savings, external)

asset_code

string

Filter accounts by asset code (e.g., USD, BRL, EUR)

entity_id

string

Filter accounts by entity ID

blocked

string

Filter accounts by blocked status (true, false)

parent_account_id

string

Filter accounts by parent account ID (UUID)

name

string

Filter accounts by name (case-insensitive, prefix match)

alias

string

Filter accounts by alias (case-insensitive, prefix match)

Response

items

any

required

limit

integer<int64>

required

Example:

10

next_cursor

string

Example:

"eyJpZCI6IjAxOTI..."

page

integer<int64>

Example:

1

prev_cursor

string

Example:

"eyJpZCI6IjAxOTE..."

Getting started

Current (v2)

Compatibility (v1)

Error handling

List all accounts

Authorizations

Path Parameters

Query Parameters

Response