# Get Stickers
This endpoint retrieves Stickers of a given Twin that are visible to the calling user.
Method | Path | Operation* |
---|---|---|
GET | /twins/{twin}/stickers | get_stickers |
*
In order for a user to perform the "get_stickers" operation, the "get_stickers" permission must be included in the list of allowed actions in the statement of the user's role.
# Request
Parameter | Type | In | Description |
---|---|---|---|
{twin} required | string | path | Twin UUID. |
context optional* | string (value is {account} , personal , or system ); or list (value is account list); DEFAULT=system | query string | You can narrow down the list of Stickers to be included in the search: - {account} : Account UUID where the Sticker were created and where the requesting user is on the "recipients" list.- personal : Stickers created by the account of the requesting user where they are on the "recipients" list. - system : Stickers in the entire Trusted Twin system where the requesting user is on the "recipients" list.- {account} list: List of account UUIDs where the Sticker were created and where the requesting user is on the "recipients" list. |
*
If no context
parameter is provided, the default value (context=system
) is used and Stickers where the requesting user is on the "recipients"
list are returned.
# Response
The response returns a list of Stickers with their attributes grouped by account UUID.
Attribute | Type | Description |
---|---|---|
note | string | Note for the recipients of the Sticker. The maximum length of a note is 512 characters. |
validity_ts | timestamp | Time at which the Sticker expires. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window). |
created_ts | timestamp | Time at which the Sticker was created. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window). |
The response returns a list of Stickers for the requested Twin grouped by account UUIDs.
# Status codes
Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.
Was this article helpful?