Audit logs

List audit logs

GET https://demo.notifuse.com/api/auditLogs.list

Returns one page of audit entries, newest first. With scope=workspace (the default) workspace_id is required and the caller must be an owner of that workspace or hold the audit_logs read permission; with scope=deployment the caller must be a root user and every entry is returned, optionally narrowed to one workspace.

Never refused for licence reasons: the page works in every licence state on whatever was recorded while a key covered audit logs.

Authorizations

Authorization string header required

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

Query Parameters

scope string
Default workspace Options workspace, deployment
workspace_id string

Required in workspace scope; optional narrowing in deployment scope.

Example ws_1234567890
actions string

Comma-separated action names, e.g. templates.update,lists.create.

categories string

Comma-separated categories.

actor_id string
actor_email string

Substring match, case-insensitive.

actor_type string
Options user, api_key, system, anonymous
outcome string
Options success, failure, denied
target_type string
target_id string
ip_address string
from string<date-time>

Only entries at or after this instant (RFC3339). A malformed value is a 400.

to string<date-time>
cursor string

The next_cursor of the previous page.

limit integer

Clamped to 100.

Default 50 Max 100

Response

200 One page object
logs object[]
Show 21 child attributes Hide 21 child attributes
id string
Example 8b8dd285f6874c17b5edcb39ef3e0b8b
occurred_at string<date-time>
workspace_id string
Example ws_1234567890
action string

The RPC route that performed the action, verbatim.

Example workspaces.inviteMember
category string
Example members
outcome string
Options success, failure, denied
status_code integer
Example 200
actor_type string
Options user, api_key, system, anonymous
actor_id string
actor_email string
actor_name string
actor_role string
Options owner, member, root
auth_method string
Options session, api_key, magic_code, sso, root_password
target_type string
Example invitation
target_id string
target_name string
Example bob@example.com
ip_address string
Example 203.0.113.9
user_agent string
request_id string

Echoed on every API response as X-Request-ID.

changes map<string, object>
Show 2 child attributes Hide 2 child attributes
old any

The value before the action

new any

The value after the action

metadata object
next_cursor string

Present when has_more is true; pass it back as cursor.

has_more boolean
400 Malformed filter object
error string required

Error message

403 Not an owner, no audit_logs read permission, or not root for the deployment scope object
error string required

Error message