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>'
import requests

url = "https://api.scrip.dev/v1/participants"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.scrip.dev/v1/participants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrip.dev/v1/participants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.scrip.dev/v1/participants"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/participants")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/participants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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"
  }
}
{
"code": "bad_request",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Invalid request parameters"
}
{
"code": "unauthorized",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Missing or invalid credentials"
}
{
"code": "forbidden",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Insufficient permissions for this action"
}
{
"code": "internal_error",
"message": "An internal error occurred"
}
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 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