Skip to main content
GET
/
v1
/
participants
/
{id}
/
state
/
tags
Get participant tags
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/state/tags \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "tag": "vip"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}
Returns all tags on a participant. Tags are boolean flags with no associated value. They are normalized to lowercase, so VIP and vip are treated as the same tag. Tags are commonly used as conditions in rules (e.g., checking whether a participant has an early-adopter tag before applying a bonus). Both rules and direct API calls can set tags, and the state history endpoint records the source of each change.
For usage patterns and examples, see the State Management guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

​
id
string<uuid>
required

Participant ID

Response

Tags list

​
data
object[]

Tag entries

​
pagination
object

Pagination metadata for list responses