API ReferenceUser Audit Logs

Retrieve a User Audit Log

Retrieves the details of an existing user audit logs for up to the most recent 6 months.

Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like user audit logs in Sandbox via API.

Path parameters

user-audit-log-idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Key-InflectionenumOptional
Determines casing for the API response.
Allowed values:
Idempotency-KeystringOptional
Ensures the request is idempotent.
Persona-VersionenumOptionalDefaults to 2023-01-05
Allowed values:

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Response

This endpoint returns a User Audit Log object and (optionally) its related objects in included.

dataobject or null
includedlist of objects or null

Objects that may be returned if specified via the include query parameter in the request.

Errors