Skip to main content
GET
Get a participant by internal ID
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. Use the include query parameter to fetch only the sections you need: a comma-separated list of programs, state (tags, counters, attributes), tiers, and balances. Omit it to get all sections, or pass include=none for the profile only. Trimming unused sections reduces response size and skips the corresponding reads server-side.
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. For usage patterns, see the Participants guide.

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

Query Parameters

include
string

Comma-separated detail sections: programs, state (tags, attributes, counters), tiers, balances. Omit for all sections; use none for profile only.

Response

Participant details

attributes
object

Key-value metadata. Each key is accessible in rules via the participant.attribute. shorthand (null if unset) or get(participant.attributes, "key", "")

Example:
balances
object[]

Current balances per asset, split by bucket

counters
object

Numeric accumulators, returned as strings for precision

Example:
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:
status
string

Lifecycle state

Example:

"ACTIVE"

tags
string[]

Labels for segmentation, accessible in rules via participant.tag. (true/false) or 'name' in participant.tags

Example:
tiers
object

Current tier level per tier type

Example:
updated_at
string<date-time>

When the participant was last modified

Example:

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