For the complete documentation index, see llms.txt. This page is also available as Markdown.

Token Listing (Api-Version: 2)

GET /tokens — requires Api-Version: 2 header

Returns all tokens. For the Standard Registry role it returns only the list of token definitions; for other users it also returns token balances as well as the KYC, Freeze, and Association statuses. Not allowed for the Auditor role.

Authentication: Bearer token required (Authorization: Bearer <token>)

Permission: Permissions.TOKENS_TOKEN_READ


Request

Headers

Header
Value
Required
Description

Api-Version

2

Yes

Enables V2 behaviour

Query Parameters

Parameter
Type
Required
Default
Description

pageIndex

number

No

0

The number of pages to skip before starting to collect the result set

pageSize

number

No

20

The number of items to return

policyId

string

No

Filter tokens associated with this policy ID

status

string

No

Token status filter. Allowed values: Associated, All


Response

Success Response

Status: 200 OK

Returns an array of token objects. The total item count is provided in the X-Total-Count response header.

Standard Registry — returns token definitions only:

Regular user — additionally includes balance, KYC, Freeze, and Association statuses:

Error Responses

Status
Description

401 Unauthorized

Missing or invalid token

403 Forbidden

Insufficient permissions or Auditor role

500 Internal Server Error

Unexpected server failure

Last updated

Was this helpful?