Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Instruments API

List Instruments

get/v1/organizations/{organization_id}/instruments

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

Query parameters

holder_idstring

Filter instruments by holder ID (UUID)

Filter instruments by holder ID (UUID)

metadatastring

JSON string to filter instruments by metadata fields

JSON string to filter instruments by metadata fields

limitstring

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

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

pagestring

Page number (default 1)

Page number (default 1)

sort_orderstring

Sort direction (asc, desc)

Sort direction (asc, desc)

include_deletedstring

Return includes logically deleted instruments (true,false)

Return includes logically deleted instruments (true,false)

account_idstring

Filter instrument by accountID

Filter instrument by accountID

ledger_idstring

Filter instrument by ledgerID

Filter instrument by ledgerID

documentstring

Filter instrument by document

Filter instrument by document

Headers

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Response

OK

{"stackTrail":"components:schemas:Pagination:properties:items","oasType":"schema","type":"unknown"}
limitinteger required
next_cursorstring
pageinteger
prev_cursorstring

Example response

{
  "limit": 10,
  "next_cursor": "eyJpZCI6IjAxOTI...",
  "page": 1,
  "prev_cursor": "eyJpZCI6IjAxOTE..."
}