Skip to main content
GET
Read the organization's audit activity (compliance feed)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "detail": Field diff, action payload and event metadata.
  • "request": Request provenance: ip, user agent, request and correlation ids.
Available options:
detail,
request
orderBy
object[]
whereActions
string[]

Filter by exact action keys (see AUDIT_ACTIONS), e.g. ["anomaly.created"].

Example:
whereActionPrefix
string

Filter by action prefix, e.g. anomaly. for every anomaly event.

Maximum string length: 200
Example:

"lobby"

whereCategories
string[]

Filter by one or more audit categories.

Example:
whereKinds
string[]

auto for field-level diffs, semantic for business events.

Example:
whereCreatedAt
object

Filter by the event date range.

Example:
whereEntityTypes
string[]

Filter by one or more audited entity types.

Example:
whereEntityId
string<uuid>

Filter by a single audited entity id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
whereActorUserIds
string<uuid>[]

Filter by the acting user ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereActorTypes
string[]

Filter by actor kind (user, system, provider, …).

Example:

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required