Sign in
Audit Log

List audit logs

List audit log records for chosen objects and actions.

Only admin or organization group admins can access the log records.

get/api/v1/audit_logs

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

object_type'document' | 'annotation' | 'user' required

Type of the object on which the action was performed. Available types are document, annotation, user

actionstring

Type of the action performed.

Multiple actions can be provided as a comma-separated list (e.g. create,update,delete).

Each object_type supports filtering by different actions:

object_typeAvailable actions
documentcreate
annotationupdate-status
usercreate, delete, purge, update, destroy, app_load, reset-password, change-password
<Callout type="info"> `app_load` value represents records of when `api/v1/auth/user` endpoint was called. </Callout>
object_idinteger

ID of the object on which the action was performed

timestamp_beforestring date-time

Filter for log entries before the given timestamp

timestamp_afterstring date-time

Filter for log entries after the given timestamp

usernamestring

Username of the user that performed the action

Response

OK

Example response

{
  "results": [
    {
      "organization_id": 406,
      "timestamp": "2024-07-01T07:00:00.000000Z",
      "username": "john.doe@example.com",
      "object_id": 131,
      "object_type": "user",
      "action": "update",
      "content": {
        "path": "api/v1/users/131",
        "method": "PATCH",
        "request_id": "a7413b88408f6b458f0859059f3cd1c1",
        "status_code": 200,
        "details": {
          "payload": {
            "groups": [
              "admin"
            ]
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.