Skip to main content
GET
List instance-wide audit events

Authorizations

Authorization
string
header
required

An Earnie API key, sent as Authorization: Bearer sk_earnie_.... Create one under Settings > API keys. The key's scopes decide which operations it may call.

Query Parameters

project_id
string<uuid>
actor_kind
enum<string>
Available options:
user,
api_key,
integration,
worker,
agent,
unauthenticated
actor_id
string<uuid>
event_type
string
q
string

Free-text search. Matches case-insensitively as a literal substring against the actor display name or the event type; LIKE metacharacters are matched literally. Trimmed, and blank means no search. The event payload is deliberately out of scope.

Maximum string length: 200
from
string<date-time>
to
string<date-time>
include_system
boolean
default:false
collapse
boolean
default:false

Fold like events into one row per occurrence group, keyed on (local day, event type, actor, project, subject). The row then reports the group's most recent member and carries occurrence_count, occurrences, occurrences_truncated and payloads_vary, and limit counts groups rather than events. Opt-in and default off: every other consumer keeps one row per event. A cursor minted in one mode cannot be replayed in the other.

tz
string

IANA time zone the collapsed local day is computed in, e.g. Europe/Madrid. Defaults to UTC. An unrecognized zone is rejected rather than silently treated as UTC, because a group collapsed on a day the caller did not ask for would straddle two of their day headings.

Maximum string length: 64
cursor
string
limit
integer
default:50
Required range: 1 <= x <= 100

Response

Audit events ordered newest first.

events
object[]
required
actors
object[]
required
event_types
string[]
required
next_cursor
string | null