---
title: "GET /audit_logs"
method: GET
path: "/audit_logs"
---

# GET /audit_logs

`GET /audit_logs`

Retrieve audit logs for employee usage of the Knot Dashboard.

## Query parameters

- `start` string, date-time
- `end` string, date-time
- `next_cursor` string

## Response `200`

Successful request.

- object
  - `data` object[]
    - `id` string, required — Unique identifier for the audit log entry.
    - `datetime` string, date-time, required — ISO 8601 datetime (YYYY-MM-DDTHH:MM:SSZ) when the action occurred.
    - `event` object, required
      - `action` string, required — The action that was performed.
      - `outcome` object, required
        - `status` string, required — The outcome status of the action.
    - `actor` object, required
      - `name` string, required — Name of the user that performed the action. `System` if no individual user performed the action.
      - `email` string — Email address of the user that performed the action.
    - `target` object, nullable, required
      - `type` 'webhook' | 'secret' | 'domain' | 'user' | 'merchant' | 'null', nullable, required — The type of target entity.
      - `name` string, nullable, required — The name of the target entity.
      - `environment` 'production' | 'development' | 'null', nullable, required — The environment associated with the target.
    - `context` object, required
      - `ip` string — IP address from which the action was performed.
      - `user_agent` string — User agent string of the browser or client used to perform the action.
  - `next_cursor` string, nullable — Cursor token for the next page of audit logs. Null if there are no further results.
  - `limit` integer — Number of items per page.

## Other responses

- `400` — Bad request.
- `401` — Unauthorized request.
- `500` — Internal server error.

---

[API](https://skmtc.net/knotapi/apis/knot-api.md) · [All operations](https://skmtc.net/knotapi/apis/knot-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/knotapi/knot-api/versions/4610832c2087/schema)