Back to API overview
Audit Logs
1 endpoint
Immutable auth and configuration events for compliance.
audit.read
Query audit events for a sub-organization. Use export=csv for CSV download.
Authenticate with your organization API key. Include
subOrgId as a query parameter or in the request body when using an org-wide key. Sub-org-scoped keys automatically target their sub-organization.GET
/v1/audit-logsList audit events with optional category filter. Requires audit.read.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
| subOrgId | string | No | Sub-organization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one sub-org. |
| limit | integer | No | Max events to return (default 50, max 200; CSV export max 1000) |
| category | string | No | Filter by audit category |
| export | string | No | Set to csv to download CSV instead of JSON |
Response — 200
{ "events": [ /* audit events */ ] }