Skip to main content
GET
/
v1
/
events
List events
curl --request GET \
  --url https://api.scrip.dev/v1/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 a paginated list of events. Filter by status, participant_id, external_id, or program_id. Use from and to to scope results by ingestion time (created_at), and event_from / event_to to scope by occurrence time (event_timestamp). Both pairs can be used simultaneously (AND semantics). Use sort_by / sort_dir to control ordering. To sort by when events occurred rather than when they were received, set sort_by=event_timestamp. Each event includes its processing status (PENDING, PROCESSING, COMPLETED, FAILED), which is useful for monitoring pipeline health or identifying events that need attention.
For usage patterns and examples, see the Event Processing guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

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
​
event_type
enum<string>

Filter by event type

Available options:
EXTERNAL,
SYSTEM
​
participant_id
string<uuid>

Filter by participant ID

​
external_id
string

Filter by external ID

​
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

​
sort_by
enum<string>

Sort field

Available options:
created_at,
event_timestamp,
status
​
sort_dir
enum<string>

Sort direction: asc or desc (default)

Available options:
asc,
desc

Response

List of events with payloads

​
data
object[]

Data contains the list of items

​
pagination
object

Pagination contains cursor information for fetching more results