Skip to main content
GET
Read the workspace audit log

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Query Parameters

actor
string

Substring matched against actor_email OR actor_sub.

action
string

Exact action name, e.g. create_webhook or reveal_destination_secret.

target
string

Exact target id.

since
string

ISO timestamp; matches at >= since.

until
string

ISO timestamp; matches at <= until.

limit
integer
default:25

Page size; non-numeric or non-positive falls back to 25, values above 100 are clamped. Ignored when format=csv (that path takes a single 5000-row page).

Required range: 1 <= x <= 100
offset
integer
default:0

Row offset; forced to 0 when format=csv.

Required range: x >= 0
format
enum<string>

Set to csv for a CSV attachment instead of JSON. Requires the manage capability (owner/admin) and is itself audited as export_audit.

Available options:
csv

Response

Newest first. JSON by default; with format=csv the body is a text/csv attachment (hookie-audit.csv) with the header at,actor_email,actor_sub,actor_agent,action,target,details.

audit
object[]
required
total
integer
required

Rows matching the same filters, for the pager.

limit
integer
required
offset
integer
required