LElerian
Instruments API

List Instruments

get/v1/organizations/{organization_id}/instruments

Request

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)

metadatastring

JSON string to filter instruments by metadata fields

limitstring

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

pagestring

Page number (default 1)

sort_orderstring

Sort direction (asc, desc)

include_deletedstring

Return includes logically deleted instruments (true,false)

account_idstring

Filter instrument by accountID

ledger_idstring

Filter instrument by ledgerID

documentstring

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

itemsunknown required
limitinteger required
next_cursorstring
pageinteger
prev_cursorstring

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.