v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB

Audit Logs

Query Audit Logs

Queries audit log events for the account using filter criteria specified in the request body. This API is exclusive to Enterprise Shield accounts. This endpoint is paginated.

post/v1/auditLogs/query

Query parameters

pageSizeinteger

The number of audit logs to return per request.

pageTokenstring

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

Request body

fromstring date-time

The start date for the audit log query range.

tostring date-time

The end date for the audit log query range.

userIdsinteger[]

Array of user IDs who initiated the logged events.

eventTypesstring[]

Array of event types to filter the audit logs.

actorIsExternalboolean

Whether the actor is external to the organization.

actorTypesstring[]

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

Example request

{
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-01-31T23:59:59Z",
  "userIds": [
    1111111,
    2222222,
    123123123
  ],
  "eventTypes": [
    "content.document.documentFolderEntrypointUpdated",
    "login.user.successfulUserLogin"
  ],
  "actorIsExternal": true,
  "actorTypes": [
    "Anonymous User",
    "Normal User",
    "Internal User",
    "Token User",
    "Unknown User"
  ]
}

Response

OK. Returns an array of audit log events matching the query.

accountIdinteger

The unique ID for the account.

eventTimestampstring date-time

The time the audit log event occurred.

flowIdstring nullable

A flow id identifier.

Example response

[
  {
    "accountId": 1,
    "eventTimestamp": "2026-06-02T17:41:20.124436108Z",
    "actor": {
      "actorType": "user",
      "actorAccountId": 1,
      "actorEmail": "user@example.com",
      "actorUserId": 100,
      "actorClient": "Chrome/51.0.2704.103 Safari/537.36"
    },
    "event": {
      "eventType": "content.document.documentOpened",
      "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",
      "product": "lucidchart",
      "documentOpenedMethod": {
        "methodType": "InApp"
      }
    },
    "target": [
      {
        "targetType": "userTarget",
        "displayName": "User Name",
        "userEmail": "user@example.com"
      }
    ],
    "flowId": "55ce2349da62cba"
  }
]