GET/tokenization/token/{id}/roles

Get Token Roles

Outcome - Lists who holds the OWNER and AGENT roles of a token of this vault. To name an agent as the signer of an operation, pass a row's wallet.publicAddress as params.signerWalletAddress (or its walletId as params.signerWalletId). A role being added or removed shows PENDING_ADDITION or PENDING_REMOVAL until its transaction completes. Removed roles are left out unless you filter by status.

Path Parameters

idnumber

Token ID

Query Parameters

limitnumberdefault: 10nullable

Number of results per page, from 1 to 100.

cursorstringnullable

Cursor from a previous response (meta.nextCursor or meta.previousCursor). Omit it for the first page.

sortKeystringdefault: idnullable

Field to sort by. Allowed values: id.

orderstringdefault: DESCnullable

Sort direction: ASC or DESC.

filtersobjectnullable

Filters, passed as filters[field]=value. Only the fields listed below are accepted; any other field returns 422.

Show child parameters (3)
rolestringnullable

OWNER or AGENT

statusstringnullable

PENDING_ADDITION, ACTIVE, PENDING_REMOVAL or REMOVED. Without it, REMOVED rows are left out.

walletIdnumbernullable

Wallet ID

Responses

Response attributes

messagestring

Response message

dataobject

The page of roles

Show child attributes (2)
dataarray

One row per wallet and role, newest first

Show child attributes (8)
idnumber

Row ID

securityTokenIdnumber

Token ID

walletIdstring

The role holder's wallet of this token (a wallet of the token's asset). Can be passed as params.signerWalletId.

walletobject

That wallet

Show child attributes (3)
idnumber

Wallet ID, the same as walletId

publicAddressstring

Address of the role holder. Can be passed as params.signerWalletAddress.

typestring

MASTER (a master wallet of the vault) or CLIENT (a client wallet)

rolestring

OWNER or AGENT

statusstring

PENDING_ADDITION (ADD_AGENT sent, not completed), ACTIVE, PENDING_REMOVAL (REMOVE_AGENT sent, not completed) or REMOVED. Only an ACTIVE agent can sign.

createdAtstring

Creation date

updatedAtstring

Last update date

metaobject

Cursor pagination. Pass meta.nextCursor as the cursor query parameter to get the next page, or meta.previousCursor to go back.

Show child attributes (5)
hasNextPageboolean

true if there are more results after this page

hasPreviousPageboolean

true if there are results before this page

nextCursorstring | null

Cursor for the next page, or null on the last page

previousCursorstring | null

Cursor for the previous page, or null on the first page

limitnumber

Page size used for this request

statusnumber

HTTP status code

Was this page helpful?