Sign in
Events

List Events

Retrieves a list of events.

When authenticated with a Tenant JWT, returns only events belonging to that tenant. When authenticated with Admin API Key, returns events across all tenants. Use tenant_id query parameter to filter by tenant.

get/events

Query parameters

tenant_idstring

Filter events by tenant ID. If not provided, returns events from all tenants.

string
OR
string[]

Filter events by topic(s). Can be specified multiple times or comma-separated.

time[gte]string date-time

Filter events with time >= value (RFC3339 or YYYY-MM-DD format).

time[lte]string date-time

Filter events with time <= value (RFC3339 or YYYY-MM-DD format).

limitinteger

Number of items per page (default 100, max 1000).

nextstring

Cursor for next page of results.

prevstring

Cursor for previous page of results.

order_by'time'

Field to sort by.

dir'asc' | 'desc'

Sort direction.

Response

A paginated list of events.

Example response

{
  "models": [
    {
      "id": "evt_123",
      "tenant_id": "tnt_123",
      "destination_id": "des_456",
      "topic": "user.created",
      "time": "2024-01-01T00:00:00Z",
      "successful_at": "2024-01-01T00:00:00Z",
      "metadata": {
        "source": "crm"
      },
      "data": {
        "user_id": "userid",
        "status": "active"
      }
    }
  ],
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100,
    "next": "MTcwNDA2NzIwMA=="
  }
}

Changes