Skip to main content
GET
/
v1
/
participants
/
{id}
/
state
/
attributes
Get participant attributes
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/state/attributes \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "key": "tier",
      "value": "gold"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt

Use this file to discover all available pages before exploring further.

Returns all key-value attributes on a participant. Attributes are string key-value pairs used to store participant metadata. Values can represent any data type (strings, numbers, or dates) and are accessible in CEL rule conditions as participant.attributes.{key}. Date-formatted attributes (e.g. birthday: "06-15" or signup_date: "2024-01-15") can also drive automations via the ATTRIBUTE_DATE schedule type. Both rules and direct API calls can modify attributes, and the state history endpoint tracks every change with its source.
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

Attributes list

​
data
object[]

Attribute entries

​
pagination
object

Pagination metadata for list responses