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

string
OR
string[]

Filter events by ID(s). Use bracket notation for multiple values (e.g., id[0]=abc&id[1]=def).

string
OR
string[]

Filter events by tenant ID(s). Use bracket notation for multiple values (e.g., tenant_id[0]=t1&tenant_id[1]=t2). When authenticated with a Tenant JWT, this parameter is ignored and the JWT's tenant is used. If not provided with API key auth, returns events from all tenants.

string
OR
string[]

Filter events by matched destination ID(s). Returns events that were routed to the specified destination(s). Use bracket notation for multiple values (e.g., destination_id[0]=d1&destination_id[1]=d2).

string
OR
string[]

Filter events by topic(s). Use bracket notation for multiple values (e.g., topic[0]=user.created&topic[1]=user.updated).

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).

time[gt]string date-time

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

time[lt]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",
      "matched_destination_ids": [
        "des_456",
        "des_789"
      ],
      "topic": "user.created",
      "time": "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