Skip to main content
GET
/
v1
/
participants
/
{id}
/
activity
/
events
List participant events
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/activity/events \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "created_at": "2024-01-15T10:30:00Z",
      "error_message": "rule condition evaluation failed",
      "event_data": {},
      "event_timestamp": "2024-01-15T10:30:00Z",
      "event_type": "EXTERNAL",
      "external_id": "user_abc123",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "idempotency_key": "order-12345-completed",
      "participant_id": "550e8400-e29b-41d4-a716-446655440002",
      "processed_at": "2024-01-15T10:30:02Z",
      "program_id": "550e8400-e29b-41d4-a716-446655440001",
      "received_at": "2024-01-15T10:30:01Z",
      "recipient_id": "550e8400-e29b-41d4-a716-446655440003",
      "status": "COMPLETED",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}
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