Sign in

v1

latestOpenAPI 3.0.02026-08-041326126.6 KB
Beta Endpoints
Audits

Audit Logs

⚠️ This endpoint is in Beta

This endpoint provides the same information that is available on the Audit Trail page.

get/api/v1/audits

Query parameters

after_checkpointstring

Return only audit entries that were created after the checkpoint. Use with the output of the 'checkpoint' field to iteratively retrieve all audit entries from the API where the total exceeds the maximum query limit.

limitinteger

The maximum number of audit entries to return per page.

Response

Request was successfully processed

checkpointstring required

A token that can be used to get more audit entries.

additional_resultsboolean required

True if there are more audit entries that can be immediately retrieved.

Example response

{
  "results": [
    {
      "type": "Permissions Granted",
      "category": "User Management",
      "details": "The moon is now \"full\" (was \"waxing gibbous\")",
      "user": "alice@example.com"
    }
  ]
}