Sign in

v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Audit Log

Get Audit Logs

Returns audit logs for an organization within a specified time range.

All audit logs include a timestamp in ISO 8601 date time format, user info, IP address, event info and device inf.

get/core/v1/audit_log

Query parameters

start_timeinteger

The start of time range for requested audit logs. Formatted as a Unix timestamp in seconds. Defaults to an hour from the current time.

end_timeinteger

The end of time range for requested audit logs. Formatted as a Unix timestamp in seconds. Defaults to the current time.

use_processed_timestampboolean

Whether to return audit logs where processed_timestamp is between start_time and end_time instead of timestamp. Useful when polling for new audit logs on a regular cadence to ensure logs that had not finished processing during an earlier polling window are still eventually captured.

Note that audit logs where timestamp is before 2025-08-12 do not support this feature.

page_tokenstring

The pagination token used to fetch the next page of results.

page_sizeinteger

The number of items returned in a single response. Default is 100. Max is 200.

Response

OK

next_page_tokenstring

The pagination token used to fetch the next page of results.

Example response

{
  "audit_logs": [
    {
      "details": {
        "success": true
      },
      "devices": null,
      "event_description": "Login successful",
      "event_name": "User Login",
      "ip_address": "fd1b:9a8c:d3ef:20a3:fdca:f931:608b:1fa5",
      "organization_id": "153818af-6726-4700-b2bf-882769006456",
      "timestamp": "2021-07-21T04:11:51Z",
      "user_id": "11205c1c-16d3-469f-b704-9e3dfa33097b",
      "user_name": "John Doe",
      "verkada_support_id": null
    },
    {
      "details": null,
      "devices": [
        {
          "details": null,
          "deviceId": "d6ec4e98-c660-4079-8f7a-2adf3b4af1f2",
          "deviceType": "camera",
          "device_name": "Front door",
          "device_site_name": "San Mateo HQ"
        }
      ],
      "event_description": "Live Stream started",
      "event_name": "Live Stream Started",
      "ip_address": "fdfc:6b74:3a02:baf1:fda6:1b58:7c40:374c",
      "organization_id": "108336c7-ece8-4c9d-b4a4-af2c4be965d9",
      "timestamp": "2021-07-21T04:11:38Z",
      "user_id": "8df56f16-0966-4532-822a-ca9a1e52e6c6",
      "user_name": "John Doe 2",
      "verkada_support_id": null
    }
  ],
  "next_page_token": null
}