v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Events

This API endpoint retrieves a list of events created in the workspace

get/v1/events

Query parameters

limitinteger

The maximum number of events to return per page. Defaults to 100 when omitted.

nextTokenstring

The pagination cursor returned in the previous response's nextToken field. Pass it back to fetch the next page.

actorIdstring

Comma-separated list of actor (user) UUIDs to filter events by.

eventTypestring

Comma-separated list of event types to filter by (e.g. clientCreated, invoicePaid).

startDatestring

Inclusive lower bound on event creation time. ISO-8601 / RFC3339 (e.g. 2026-03-01T00:00:00Z).

endDatestring

Inclusive upper bound on event creation time. ISO-8601 / RFC3339 (e.g. 2026-03-31T23:59:59Z).

Response

nextTokenstring

Example response

{
  "data": [
    {
      "id": "35e1dd1d-5fe8-49e2-b154-7fc0506aabc1",
      "object": "auditLog",
      "actorId": "ab7bd961-0c87-4446-9037-ead4fbc3986f",
      "actorType": "internalUser",
      "source": "platform",
      "eventType": "customEvent.testing",
      "eventDescription": "user starting testing in platform",
      "context": {
        "clientName": "ari",
        "topic": "testing"
      },
      "ip": "67.166.31.192",
      "userAgent": "PostmanRuntime/7.37.3",
      "createdAt": "2026-03-12T20:24:26.206496361Z",
      "updatedAt": "2026-03-12T20:24:26.206496361Z"
    }
  ],
  "nextToken": "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7Li4ufX0="
}