Skip to main content
GET
List participant events
Returns events that have been processed for a participant. Each event represents an external action (such as a purchase or login) that was sent to Scrip and evaluated against the program’s rules. Filter by program_id or status, and use from / to to scope results by ingestion time (created_at). Use event_from / event_to to filter by occurrence time (event_timestamp) instead. Both pairs can be used simultaneously (AND semantics). See Timestamps for the distinction.
For usage patterns and examples, 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

Participant ID

Query Parameters

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 event status

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
from
string<date-time>

Start of time window (RFC 3339) — filters on system ingestion time

to
string<date-time>

End of time window (RFC 3339) — filters on system ingestion time

event_from
string<date-time>

Start of event occurrence window (RFC 3339) — filters on event_timestamp

event_to
string<date-time>

End of event occurrence window (RFC 3339) — filters on event_timestamp

Response

List of events

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results