Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
time,
-time
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • in(id,[xxx]): Filter by event ID(s)
  • in(organisation,[xxx]): Filter events by the organisation ID
  • in(resource.type,[xxx]): Filter events by the resource type
  • in(resource.id,[xxx]): Filter events by the resource ID

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
user,
organisation

Response

List of audit events.

JSON API response object

data
A list of audit events · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when an audit event is returned

An organisation