Skip to main content
GET
List Holders

Headers

X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Authorization
string

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>

Path Parameters

organization_id
string<uuid>
required

The unique identifier of the Organization associated with the Ledger.

Query Parameters

metadata
string

JSON string to filter holders 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 holders (true,false)

external_id
string

Filter holders by externalID

document
string

Filter holders by document

Response

OK

items
any
required
limit
integer<int64>
required
Example:

10

next_cursor
string
Example:

"eyJpZCI6IjAxOTI..."

page
integer<int64>
Example:

1

prev_cursor
string
Example:

"eyJpZCI6IjAxOTE..."