API Reference
Community

Query Audit Logs

post
https://api.lucid.co/v2/auditLogs/query

Queries audit log events for the account using filter criteria specified in the request body.

This API is exclusive to Enterprise Shield accounts.

For a complete list of audit log event types and their schemas, see
Audit Log Events. For a complete list of actor and
target types, see Actors and Targets.

This endpoint is paginated. For more information, see
Pagination.

Valid Authentication Methods

API Key Grants:

  • AccountRead
  • AuditLogsRead

OAuth 2.0 User Token and Account Token Scopes:

  • account.audit.logs
Query Params
integer
Defaults to 200

The number of audit logs to return per request.

string

A token used for pagination to retrieve the next page of results when polling audit logs.

Body Params
date-time

The start date for the audit log query range.

date-time

The end date for the audit log query range.

userIds
array of integers

Array of user IDs who initiated the logged events.

userIds
eventTypes
array of strings

Array of event types to filter the audit logs.

eventTypes
boolean

Whether the actor is external to the organization.

actorTypes
array of strings

Array of actor types to filter the audit logs. See Actors and Targets for more details.

actorTypes
Responses

400

Bad request. Occurs when the query parameters are invalid.

403

Forbidden. Occurs when the authorized token does not have permission to access audit logs.

429

Too Many Requests if the account makes more than 250 requests in 1 minute.

Updated 5 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?
Privacy
Legal
Cookie privacy choices
Cookie policy