Sign in

v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
events

Returns a list of Event objects.

get/events

Query parameters

start_date_filterstring

A start date filter for the events.

end_date_filterstring

An end date filter for the events.

actor_filterstring uuid

An actor filter for the events. Supply the ID of the actor.

object_filterstring uuid

An object filter for the events. Supply the ID of the object.

event_type_filterstring

An event type filter for the events.

api_token_filterstring

An API filter for the events. Supply the name and preview of the API token.

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page. Default is 200.

Response

One page worth of events with the appropriate filters applied.

nextstring nullable

The cursor with which to continue pagination if additional result pages exist.

previousstring nullable

The cursor used to obtain the current result page.

Example response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "event_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "actor_user_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "created_at": "2022-01-23T04:56:07Z",
      "event_type": "USERS_CREATED"
    },
    {
      "event_id": "7646aa9a-e2ee-4eb5-8c62-91f29038a373",
      "actor_user_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "created_at": "2022-02-03T12:33:02Z",
      "event_type": "USER_TEAM_UPDATED"
    }
  ]
}