---
title: "GET /auditLogs"
method: GET
path: "/auditLogs"
tags: ["Auditlog"]
---

# GET /auditLogs

`GET /auditLogs`

This endpoint filters audit events by userId, targetId, targetType, auditType

## Query parameters

- `include` 'description' | 'userAgent' | 'data' | 'ipAddressLocation'
- `userId` string
- `targetId` string
- `targetType` 'user' | 'account' | 'device' | 'file'
- `locationId` string
- `auditType` 'requestDownload' | 'saveDownload' | 'createDevice' | 'deleteDevice' | 'updateDevice' | 'createAccount' | 'updateAccount' | 'createUser' | 'createUserSso' | 'deleteUser' | 'updateUser' | 'switchAccount' | 'devicesOn' | 'devicesOff' | 'deviceRestart' | 'userLogin' | 'userLogout' | 'getLayout' | 'createLayout' | 'deleteLayout' | 'updateLayout' | 'managedSwitchControl' | 'managedSwitchUpdate' | 'forgotPassword' | 'resetPassword' | 'videoRecordStart' | 'videoRecordEnd' | 'viewVideoEnd' | 'viewVideoStart' | 'createFile' | 'deleteFile' | 'updateFile' | 'activateFirstResponders' | 'deactivateFirstResponders' | 'openTunnel' | 'closeTunnel' | 'activeOutput0' | 'activeOutput1' | 'activeOutput2' | 'activeOutput3' | 'lprSearch' | 'videoSearch' | 'cameraSnapshot' | 'talkdownSessionStarted' | 'talkdownSessionFinished' | 'createLocation' | 'updateLocation' | 'deleteLocation' — Valid values given by /auditTypes endpoint.
- `timestamp__gte` string, date-time
- `timestamp__lte` string, date-time
- `pageToken` string
- `pageSize` integer

## Response `200`

List of audit events

- AuditEvents — Used to wrap results for a paginated response, containing information on how to retrieve further pages.
  - `nextPageToken` string, nullable, required — Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.
  - `prevPageToken` string, nullable, required — Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.
  - `results` CreateAuditEvent[], required — The result set from a collection API call.
    - `timestamp` string, date-time
    - `userId` string, required
    - `userName` string
    - `userEmail` string
    - `accountId` string, required
    - `auditType` string, required
    - `targetType` string, required
    - `targetId` string, required
    - `targetName` string, required
    - `ipAddress` string
    - `userAgent` object
      - `browserFamily` string
      - `browserVersion` string
      - `osFamily` string
      - `osVersion` string
    - `locationId` string, nullable — ID Of the location.
    - `locationName` string
    - `dataSchemas` string[]
    - `data` GenericDetails[] — Structured audit details organized into sections for data-driven UI rendering. Each section represents a logical grouping of related settings or information, typically corresponding to a page or sub-section in the web application UI. The frontend can display new audit types and details without code changes by rendering these sections as labeled groups with rows of label-value pairs.
      - `type` 'details', required — Section type identifier. Currently only 'details' is supported. Additional section types may be added in the future.
      - `id` string, required — Machine-readable identifier for this section in camelCase. Should match the corresponding API v3 field name when applicable.
      - `header` string, required — Human-readable section label shown to users, representing a breadcrumb path to the corresponding screen in the web application. Use " - " as a separator for nested screens.
      - `rows` object[], required — List of setting changes or information displayed as rows in a table, each showing a label, current value, and optionally the previous value.
        - `id` string, required — Machine-readable identifier in camelCase. Should match the corresponding API v3 field name when applicable to make it easy to relate the API and audit log.
        - `label` string, required — Human-readable label displayed to users in the frontend application UI, matching the label shown in the corresponding settings screen. Should be written in English.
        - `value` string, required — Current value of the setting as a string. Use empty string "" to represent "no value" rather than null.
        - `format` 'date-time' | 'boolean' — Optional format hint for the frontend to properly parse and display the value. * `date-time`: Value is an ISO 8601 timestamp and should be rendered as a formatted date/time. * `boolean`: Value is a boolean toggle (expects "Yes", "True", "No", or "False").
        - `oldValue` string — Previous value of the setting before the change. Only include when there was a previous value (e.g., on updates). Omit for creates or when not applicable. Use empty string "" to represent "no value" rather than null.

## Other responses

- `400` — The supplied object is invalid. Error detail will contain the validation error.
- `401` — You are not authenticated. Please authenticate and try again.
- `403` — You have no permission to access the specified resource.
- `500` — Something went wrong in the server. Please try again.

---

[API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)