# Get a Sticker

This endpoint retrieves the details of a given Sticker put on a given Twin.

Method Path Operation*
GET /twins/{twin}/stickers/{color} get_sticker

*

In order for a user to perform the "get_sticker" operation, the "get_sticker" 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.
color
required
string path User-defined category of the Sticker. Must be unique in the context of an account. Must match the regular expression (opens new window) ^[a-z_][0-9a-z_]{0,127}$.

# Response

Attribute Type Description
message string Message for the recipients of the Sticker. The maximum length of a message is 256 characters.
recipients list of strings List of user UUIDs, role UUIDs, and account UUIDs that should be able to access and remove the sticker. The maximum number of items on the list is 100.
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).
publish
optional**
set of strings, values are "on_put", "on_remove" or "on_expire" List of events that should trigger a notification message for the Sticker. The event can be one of the following:
- "on_put": A notification message is triggered when a Sticker of the given color is put on a given Twin.
- "on_remove": A notification message is triggered when a Sticker of a given color is removed from the given Twin.
- "on_expire": A notification message is triggered when the "validity_ts" of a Sticker is reached and the Sticker expires. A notification message is triggered up to 60 seconds from the time a Sticker has expired.

# Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.