Participants

List participant events

Retrieve events for a participant.

get/v1/participants/{participant_id}/activity/events

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/participants/{participant_id}/activity/events
Auth: HTTP bearer

Path parameters

participant_idstring required

The participant's id, or ext: followed by the participant's external_id.

Query parameters

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'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED'

Filter by event status

event_type'EXTERNAL' | 'SYSTEM' | 'OPERATIONAL'

Return only events of this type.

rule_idstring uuid

Return only events that this rule ran on.

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.

occurred_afterstring date-time

Return only events with an event_timestamp after this time, RFC 3339.

occurred_beforestring date-time

Return only events with an event_timestamp before this time, RFC 3339.

Response

List of events

Example response

{
  "data": [
    {
      "created_at": "2027-01-15T10:30:00Z",
      "error_code": "program_not_found",
      "error_message": "rule condition evaluation failed",
      "event_data": {
        "amount": 120,
        "type": "purchase"
      },
      "event_timestamp": "2027-01-15T10:30:00Z",
      "event_type": "EXTERNAL",
      "external_id": "user_123",
      "id": "e5dc1b6a-7f3d-4e2a-8c1b-9a0f4d7e6c05",
      "idempotency_key": "order-1001-completed",
      "participant_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b006",
      "processed_at": "2027-01-15T10:30:00Z",
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "received_at": "2027-01-15T10:30:00Z",
      "recipient_id": "f7a8b9c0-1d2e-4f3a-b4c5-d6e7f8a9b007",
      "status": "COMPLETED",
      "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.