Saltar al contenido principal
GET
List Instruments

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

organization_id
string
requerido

Organization ID (UUID)

Parámetros de consulta

holder_id
string

Filter instruments by holder ID (UUID)

metadata
string

JSON string to filter instruments by metadata fields

limit
string

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

page
string

Page number (default 1)

sort_order
string

Sort direction (asc, desc)

include_deleted
string

Return includes logically deleted instruments (true,false)

account_id
string

Filter instrument by accountID

ledger_id
string

Filter instrument by ledgerID

document
string

Filter instrument by document

banking_details_branch
string

Filter instruments by banking details branch (exact, case-sensitive match on the stored value)

banking_details_account
string

Filter instruments by banking details account number (exact, case-sensitive match on the stored value)

banking_details_iban
string

Filter instruments by banking details IBAN (exact, case-sensitive match on the stored value)

regulatory_fields_participant_document
string

Filter instruments by regulatory participant document (exact match on the stored value; no CPF/CNPJ formatting is stripped)

Filter instruments with any related party holding this document (exact match on the stored value; no CPF/CNPJ formatting is stripped)

Filter instruments with any related party in this role (exact, case-sensitive: PRIMARY_HOLDER, LEGAL_REPRESENTATIVE, RESPONSIBLE_PARTY)

Respuesta

OK

items
any
requerido
limit
integer<int64>
requerido
Ejemplo:

10

next_cursor
string
Ejemplo:

"eyJpZCI6IjAxOTI..."

page
integer<int64>
Ejemplo:

1

prev_cursor
string
Ejemplo:

"eyJpZCI6IjAxOTE..."