auditLog.list

Beta

This feature is in beta and may not be available for all organizations.

Lists an organization's audit log entries, newest first. The targetTypes and categories you can filter on are a fixed, code-defined vocabulary; see the Audit Log Vocabulary guide for valid values and filter examples.

Pagination: follow the opaque cursor / nextCursor; see the Pagination and Incremental Synchronization guide.

Requires the auditLogsRead permission. Returns audit events for all objects in the organization, including confidential jobs and projects, with no confidentiality filtering. The org must have the Audit Logs feature enabled.

Error codes:

CodeDescription
invalid_inputA date bound is not a valid ISO 8601 date, endDate is before startDate, the explicit span exceeds 18 months, or a targetTypes / categories value is not in the vocabulary.
audit_logs_not_enabledYour organization does not have the Audit Logs feature.
cursor_invalidThe provided cursor could not be decoded.
missing_endpoint_permissionThe API key lacks the auditLogsRead scope. Returned with HTTP 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Opaque cursor indicating which page of results to fetch

number

The maximum number of items to return. The maximum and default value is 100.

string

ISO 8601 start of the date window (UTC). When omitted, defaults to 24 hours before endDate. When only startDate is supplied, endDate defaults to startDate plus 24 hours (not until now) — use both bounds for a custom span.

string

ISO 8601 end of the date window (UTC). When omitted with startDate, defaults to startDate plus 24 hours; when both are omitted, defaults to the current time.

actorIds
array of strings
length ≤ 100

Restricts results to entries whose actor id is one of these values. An empty array is ignored, same as omitting this field. Max 100 items.

actorIds
targetIds
array of strings
length ≤ 100

Restricts results to entries whose target object id is one of these values. Combined with other filters using AND (all conditions must match). An empty array is ignored. Max 100 items.

targetIds
targetTypes
array of strings
length ≤ 100

Restricts results to entries whose target type is one of these values (e.g. "job", "app_user"). When both targetTypes and categories are supplied, matching uses OR (entries that match either filter). Combined with targetIds and actorIds using AND. An empty array is ignored. Max 100 items.

targetTypes
categories
array of strings
length ≤ 100

Restricts results to entries in one of these categories (e.g. "JobStatusChanged"). Max 100 items. See the Audit Log Vocabulary guide.

categories
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json