Skip to main content

List Events

Retrieve a paginated list of event definitions for your organization.

Endpoint

GET /events

Query Parameters

ParameterTypeDefaultDescription
limitnumber20Items per page (min: 1, max: 100)
afterstringCursor — return items after this id (exclusive).
beforestringCursor — return items before this id (exclusive).
searchstringFilter by event name (case-insensitive contains)

Results are returned newest first. See Pagination for cursor details.

Response

{
"object": "list",
"has_more": false,
"data": [
{
"id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
"name": "order.completed",
"description": "Fired when a customer completes checkout.",
"schema": {
"fields": [
{ "name": "order_id", "type": "string", "required": true }
]
},
"created_at": "2026-06-01T12:00:00.000Z",
"updated_at": "2026-06-01T12:00:00.000Z"
}
]
}

See Create Event for the per-item field reference.


Examples

curl "https://api.arsel.sa/v1/events?limit=20&search=order" \
-H "Authorization: Bearer be_your_api_key"

Error Responses

{
"status_code": 401,
"name": "unauthorized",
"message": "Invalid or missing API key"
}