Skip to main content
GET
/
v1
/
participants
/
{id}
/
state
/
tiers
List participant tiers
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/state/tiers \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "acquired_at": "2024-06-01T00:00:00Z",
      "benefits": {},
      "expires_at": "2025-06-01T00:00:00Z",
      "key": "status",
      "level": "gold",
      "rank": 2
    }
  ]
}

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 a participant’s current tier levels for a program. The program_id query parameter is required. The participant must be enrolled in the specified program. Each entry in the data array represents the participant’s standing in one tier, including their current level, rank, any benefits granted by that level, and timestamps for acquired_at and expires_at.
For usage patterns and examples, see the Tiers 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

Query Parameters

​
program_id
string<uuid>
required

Program ID to scope the tier lookup

Response

List of participant tier states

List of participant tier states

​
data
object[]