Docs Open org

API reference

Audit API

The audit log

GET /orgs/{org}/audit

Audit events you can see, newest first.

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.
actorquerystring (uuid)Only events by this actor.
actionquerystringOnly this action, or a prefix ending in * (secret.*).
resourcequerystring (uuid)Only events about this resource.
spacequerystring (uuid)Only events in this space.
taskquerystring (uuid)Only events for this task.
fromquerystring (date-time)Events at or after.
toquerystring (date-time)Events before.
limitqueryinteger (int32)Page size (default 50, max 200).
cursorquerystringThe next_cursor of the previous page.

Responses

200
OK. Paged_AuditEntry application/json

GET /orgs/{org}/audit/anchors

Published daily anchors (admins).

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.

Responses

200
OK. Paged_Anchor application/json

GET /orgs/{org}/audit/export

Streams the log as JSONL or CSV (admins). The export itself is audited.

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.
formatqueryExportFormatjsonl (default) or csv.
fromquerystring (date-time)From (inclusive).
toquerystring (date-time)To (exclusive).

Responses

200
JSONL or CSV. application/x-ndjson

GET /orgs/{org}/audit/verify

Recomputes the hash chain and reports the first break (admins). A break alerts every admin.

Parameters

NameInTypeDescription
org requiredpathstringThe org slug.
fromquerystring (date-time)From (inclusive).
toquerystring (date-time)To (exclusive).

Responses

200
OK. VerifyReport application/json