Skip to main content
GET
Listar Instrumentos

Cabeçalhos

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization
string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

organization_id
string<uuid>
obrigatório

O identificador único da Organização associada ao Ledger.

Parâmetros de consulta

holder_id
string

Filtrar instrumentos por ID do titular (UUID)

metadata
string

String JSON para filtrar instrumentos por campos de metadata

limit
string

Máximo de itens por página (1-100, padrão 10)

page
string

Número da página (padrão 1)

sort_order
string

Direção da ordenação (asc, desc)

include_deleted
string

O retorno inclui instrumentos excluídos logicamente (true,false)

account_id
string

Filtrar instrumento por accountID

ledger_id
string

Filtrar instrumento por ledgerID

document
string

Filtrar instrumento por documento

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..."