Skip to main content
GET
/
v1
/
participants
/
{id}
Get a participant by internal ID
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id} \
  --header 'X-API-Key: <api-key>'
{
  "attributes": {
    "plan": "premium",
    "region": "us-east"
  },
  "balances": [
    {
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "available": "1500.00",
      "deferred": "0.00",
      "held": "200.00"
    }
  ],
  "counters": {
    "points_earned": "1500",
    "purchases": "42"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "display_name": "Jane Doe",
  "email": "jane@example.com",
  "external_id": "user_123",
  "first_name": "Jane",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "last_name": "Doe",
  "phone": "+15551234567",
  "program_ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "status": "ACTIVE",
  "tags": [
    "vip"
  ],
  "tiers": {
    "loyalty": {
      "level": "gold",
      "rank": 2
    }
  },
  "updated_at": "2024-01-15T10:30:00Z"
}

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 single participant by Scrip id with inline state: balances, tags, counters, attributes, tiers, program_ids, and profile fields (email, phone, first_name, last_name, display_name). To look up a participant by your application’s user ID instead, use the list endpoint filtered by external_id.
The list endpoint returns a slim response (id, external_id, status, profile fields, timestamps). Use this detail endpoint when you need the full participant state.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Internal participant UUID

Response

Participant details

​
attributes
object

Key-value metadata. Each key is accessible in rules as participant.attributes.{key}

Example:
{ "plan": "premium", "region": "us-east" }
​
balances
object[]

Current balances per asset, split by bucket

​
counters
object

Numeric accumulators, returned as strings for precision

Example:
{
  "points_earned": "1500",
  "purchases": "42"
}
​
created_at
string<date-time>

When the participant was created

Example:

"2024-01-15T10:30:00Z"

​
display_name
string

Display name

Example:

"Jane Doe"

​
email
string

Contact email

Example:

"jane@example.com"

​
external_id
string

Your application's identifier for this user

Example:

"user_123"

​
first_name
string

First name

Example:

"Jane"

​
id
string<uuid>

Participant ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
last_name
string

Last name

Example:

"Doe"

​
phone
string

Contact phone

Example:

"+15551234567"

​
program_ids
string[]

Programs this participant is enrolled in

Example:
["550e8400-e29b-41d4-a716-446655440000"]
​
status
string

Lifecycle state

Example:

"ACTIVE"

​
tags
string[]

Labels for segmentation, accessible in rules as participant.tags

Example:
["vip"]
​
tiers
object

Current tier level per tier type

Example:
{ "loyalty": { "level": "gold", "rank": 2 } }
​
updated_at
string<date-time>

When the participant was last modified

Example:

"2024-01-15T10:30:00Z"