Participants

List participants

Returns a paginated list of participants. When external_id is provided, it is treated as an exact-match filter and the response shape remains the same list envelope.

get/v1/participants

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/participants
Auth: HTTP bearer

Query parameters

external_idstring

Exact-match filter by external ID

limitinteger

Return at most this many records, from 1 to 200, default 50.

cursorstring

The next_cursor from the previous response, valid only with the same endpoint and filters.

program_idstring uuid

Filter by program ID

status'ACTIVE' | 'SUSPENDED' | 'CLOSED'

Filter by participant status

searchstring

Search by external ID (partial match)

created_afterstring date-time

Return only records created after this time, RFC 3339.

created_beforestring date-time

Return only records created before this time, RFC 3339.

sort_by'created_at' | 'external_id' | 'status'

Sort field

sort_dir'asc' | 'desc'

Sort direction

Response

Paginated participant list

Example response

{
  "data": [
    {
      "created_at": "2027-01-15T10:30:00Z",
      "display_name": "Jane Doe",
      "email": "jane@example.com",
      "external_id": "user_123",
      "first_name": "Jane",
      "id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
      "last_name": "Doe",
      "phone": "+15551234567",
      "status": "ACTIVE",
      "updated_at": "2027-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.