Skip to main content
GET
Error

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

organization_id
string
obrigatório

Organization ID (UUID)

ledger_id
string
obrigatório

Ledger ID (UUID)

Parâmetros de consulta

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)

Resposta

OK

items
any
obrigatório
limit
integer<int64>
obrigatório
Exemplo:

10

next_cursor
string
Exemplo:

"eyJpZCI6IjAxOTI..."

page
integer<int64>
Exemplo:

1

prev_cursor
string
Exemplo:

"eyJpZCI6IjAxOTE..."