v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

List Events

get/events

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

category.instring[]

Filter Events for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

associated_object_idstring

Filter Events to those belonging to the object with the provided identifier.

order_by.direction'ascending' | 'descending'

The direction to order in.

order_by.field'created_at'

The field to order by.

Response

Event List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "associated_object_id": "account_in71c4amph0vgo2qllky",
      "associated_object_type": "account",
      "category": "account.created",
      "created_at": "2020-01-31T23:59:59Z",
      "id": "event_001dzz0r20rzr4zrhrr1364hy80",
      "type": "event"
    }
  ],
  "next_cursor": "v57w5d"
}