Skip to main content
GET
/
v1
/
participants
List participants
curl --request GET \
  --url https://api.scrip.dev/v1/participants \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "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",
      "status": "ACTIVE",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "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 a paginated list of participants. Filter by status or program_id, use search for partial matching on external_id, email, phone, first_name, last_name, or display_name, and from / to to scope by enrollment date. When external_id is provided, the list is filtered to the single matching participant. The response shape stays the same (paginated list with data[]), so client code does not need to branch on the query parameters used.
The list response includes id, external_id, status, profile fields, and timestamps. To get the full state (balances, tags, counters, attributes, tiers), use the detail endpoint.

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
external_id
string

Exact-match filter by external ID

​
limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
​
cursor
string

Pagination cursor from previous response

​
program_id
string<uuid>

Filter by program ID

​
status
enum<string>

Filter by participant status

Available options:
ACTIVE,
SUSPENDED,
CLOSED
​
search
string

Search by external ID (partial match)

​
from
string<date-time>

Filter by created_at: start of range (RFC 3339)

​
to
string<date-time>

Filter by created_at: end of range (RFC 3339)

​
sort_by
enum<string>

Sort field

Available options:
created_at,
external_id,
status
​
sort_dir
enum<string>

Sort direction

Available options:
asc,
desc

Response

Paginated participant list

​
data
object[]

Data contains the list of items

​
pagination
object

Pagination contains cursor information for fetching more results