---
title: "List audit logs"
method: GET
path: "/api/audit-logs"
tags: ["Audit log"]
---

# List audit logs

`GET /api/audit-logs`

Retrieve a paginated list of audit log entries for the organisation. Supports filtering by project, user, date range, type, and action.

## Query parameters

- `projectId` string, uuid
- `userId` string, uuid
- `fromDate` string
- `toDate` string
- `type` 'organisation' | 'user' | 'group' | 'accessToken' | 'project' | 'document' | 'release' | 'member' | 'personalAccessToken'
- `action` string
- `orderBy` string
- `sort` string
- `page` number
- `perPage` number

## Response `200`

Paginated list of audit logs

- object — Paginated list of audit logs
  - `results` object[], required — List of audit log entries
    - `id` string, uuid, required — Unique identifier of the audit log entry
    - `createdAt` string, required — Timestamp when the action was performed
    - `type` 'organisation' | 'user' | 'group' | 'accessToken' | 'project' | 'document' | 'release' | 'member' | 'personalAccessToken', required — Category of the audited resource
    - `action` string, required — Specific action that was performed
    - `ipAddress` string, nullable, required — IP address of the client that performed the action
    - `userAgent` string, nullable, required — User agent of the client that performed the action
    - `refId` string, nullable, required — Reference ID of the affected resource
    - `user` object, nullable — User who performed the action
      - `id` string, uuid, required
      - `email` string, email, required
      - `firstName` string, nullable, required
      - `lastName` string, nullable, required
    - `project` object, nullable — Project associated with the audit log entry
      - `id` string, uuid, required
      - `name` string, required
  - `paginate` object, required — Pagination metadata
    - `current` number, required — Current page number
    - `from` number, required — Starting record number on the current page
    - `to` number, required — Ending record number on the current page
    - `total` number, required — Total number of records
    - `pageSize` number, required — Number of records per page

---

[API](https://skmtc.dev/gorules/apis/gorules-agent-api.md) · [All operations](https://skmtc.dev/gorules/apis/gorules-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gorules/gorules-agent-api/revisions/52c0773fcd80/schema)