> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clustr-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Audit Log

> Your organization's own audit trail, newest first. Every call to this API is recorded,
and so is every write an organization key makes while acting as a workspace on the public
API, with the key, the workspace, the action and the HTTP status.

**Scope:** none. Any valid organization key can read the audit log.




## OpenAPI

````yaml /enterprise/openapi.yaml get /audit-log
openapi: 3.1.0
info:
  title: Clustr Organization API
  description: >
    Organization-level operations for partners who run Clustr for many clients:
    workspaces, the

    signed webhook, usage and contract limits, erasure and the audit log.


    This API covers the organization only. Everything a workspace does (imports,
    jobs, search,

    saved views, tags) is the public API at
    `https://api.clustr-ai.com/api/public`, called with the

    organization key and an `X-Clustr-Tenant` header.


    ## Authentication

    Every endpoint needs an organization API key (it starts with `clo_`) in the

    `Authorization` header.


    ```

    Authorization: Bearer clo_...

    ```


    Clustr staff create organization keys. Each key carries scopes; an operation
    that needs a

    scope the key lacks answers `403`.
  version: '1.0'
  contact:
    name: Clustr Support
    url: https://clustr-ai.com
servers:
  - url: https://api.clustr-ai.com/api/org/v1
    description: Production
security:
  - OrgKey: []
tags:
  - name: Workspaces
    description: >-
      Create, read, rename, suspend, resume and delete the workspaces of your
      organization.
  - name: Webhook
    description: The organization's signed webhook, its secret and its deliveries.
  - name: Usage and limits
    description: >-
      What your organization used, the monthly statement, and your contract
      limits.
  - name: Erasure
    description: Remove one person from every workspace of the organization.
  - name: Audit log
    description: The organization's own record of every call.
paths:
  /audit-log:
    get:
      tags:
        - Audit log
      summary: List Audit Log
      description: >
        Your organization's own audit trail, newest first. Every call to this
        API is recorded,

        and so is every write an organization key makes while acting as a
        workspace on the public

        API, with the key, the workspace, the action and the HTTP status.


        **Scope:** none. Any valid organization key can read the audit log.
      operationId: listAuditLog
      parameters:
        - name: limit
          in: query
          required: false
          description: Entries to return. Default 100, at most 500.
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
      responses:
        '200':
          description: The audit entries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogResponse'
              example:
                success: true
                data:
                  - organizationId: 5d8e2b1a-0c3f-4e7d-9a6b-1f2e3d4c5b6a
                    apiKeyId: 2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e
                    action: POST /api/org/v1/tenants
                    method: POST
                    path: /api/org/v1/tenants
                    status: 201
                    createdAt: '2026-10-13T09:30:00Z'
                  - organizationId: 5d8e2b1a-0c3f-4e7d-9a6b-1f2e3d4c5b6a
                    apiKeyId: 2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e
                    action: POST /api/public/network/import/connectors
                    tenantId: 3f6c1d2e-8a4b-4c1f-9e2d-7b5a0c9e1f42
                    method: POST
                    path: /api/public/network/import/connectors
                    status: 200
                    createdAt: '2026-10-13T09:31:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '502':
          $ref: '#/components/responses/BadGateway'
components:
  schemas:
    AuditLogResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/AuditEntry'
    AuditEntry:
      type: object
      required:
        - organizationId
        - action
      properties:
        organizationId:
          type: string
          format: uuid
        apiKeyId:
          type: string
          format: uuid
          description: The key that made the call. Omitted for actions not made with a key.
        actor:
          type: string
          description: >-
            Who acted when it was not a key, for example a signed-in
            organization admin or `erasure-worker`.
        action:
          type: string
          description: >-
            The method and route, such as `POST /api/org/v1/tenants`, or a named
            action such as `erasure.tenant`.
          example: POST /api/org/v1/tenants
        tenantId:
          type: string
          format: uuid
          description: The workspace the action was about, when there was one.
        method:
          type: string
          example: POST
        path:
          type: string
          example: /api/org/v1/tenants
        status:
          type: integer
          description: The HTTP status the call answered.
          example: 201
        detail:
          type: object
          additionalProperties: true
          description: Extra facts for some actions, such as an erasure's counts.
        createdAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      description: >-
        Every error has this shape. Branch on `error.code`; `error.message` is
        for people.
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                A stable code to branch on, such as `BAD_REQUEST`, `NOT_FOUND`
                or `CONFLICT`.
              example: BAD_REQUEST
            message:
              type: string
              description: A sentence a person can read.
              example: Invalid request body.
            request_id:
              type: string
              description: Quote it to Clustr support.
  responses:
    Unauthorized:
      description: >-
        The key is missing, invalid or revoked, or it is not an organization
        key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or revoked API key
    TooManyRequests:
      description: >-
        Your organization is over its rate limit. The limit is shared by all
        keys and workspaces of the organization. Wait for `Retry-After`, then
        retry.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: RATE_LIMITED
              message: Too many requests
    BadGateway:
      description: The organization service could not be reached. Retry later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UPSTREAM_UNAVAILABLE
              message: The organization service is unavailable
  headers:
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests per second allowed for your organization.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window. Always `0` on a `429`.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time (seconds) when requests are allowed again.
      schema:
        type: integer
  securitySchemes:
    OrgKey:
      type: http
      scheme: bearer
      description: >-
        Organization API key (`clo_...`). The `X-API-Key` header is also
        accepted in place of `Authorization: Bearer`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.