/tokenization/token/{id}/rolesGet 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
idnumberToken ID
Query Parameters
limitnumberdefault: 10nullableNumber of results per page, from 1 to 100.
cursorstringnullableCursor from a previous response (meta.nextCursor or meta.previousCursor). Omit it for the first page.
sortKeystringdefault: idnullableField to sort by. Allowed values: id.
orderstringdefault: DESCnullableSort direction: ASC or DESC.
filtersobjectnullableFilters, passed as filters[field]=value. Only the fields listed below are accepted; any other field returns 422.
Show child parameters (3)
rolestringnullableOWNER or AGENT
statusstringnullablePENDING_ADDITION, ACTIVE, PENDING_REMOVAL or REMOVED. Without it, REMOVED rows are left out.
walletIdnumbernullableWallet ID
Responses
Response attributes
messagestringResponse message
dataobjectThe page of roles
Show child attributes (2)
dataarrayOne row per wallet and role, newest first
Show child attributes (8)
idnumberRow ID
securityTokenIdnumberToken ID
walletIdstringThe role holder's wallet of this token (a wallet of the token's asset). Can be passed as params.signerWalletId.
walletobjectThat wallet
Show child attributes (3)
idnumberWallet ID, the same as walletId
publicAddressstringAddress of the role holder. Can be passed as params.signerWalletAddress.
typestringMASTER (a master wallet of the vault) or CLIENT (a client wallet)
rolestringOWNER or AGENT
statusstringPENDING_ADDITION (ADD_AGENT sent, not completed), ACTIVE, PENDING_REMOVAL (REMOVE_AGENT sent, not completed) or REMOVED. Only an ACTIVE agent can sign.
createdAtstringCreation date
updatedAtstringLast update date
metaobjectCursor pagination. Pass meta.nextCursor as the cursor query parameter to get the next page, or meta.previousCursor to go back.
Show child attributes (5)
hasNextPagebooleantrue if there are more results after this page
hasPreviousPagebooleantrue if there are results before this page
nextCursorstring | nullCursor for the next page, or null on the last page
previousCursorstring | nullCursor for the previous page, or null on the first page
limitnumberPage size used for this request
statusnumberHTTP status code
Was this page helpful?