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

# List audit logs

> List the audit logs of the workspace, newest first. You can limit them to a date range. When `page_number` is omitted, all matching logs are returned.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace’s subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](https://apidocs.neetoform.com/api/workspace-subdomain.md).


## OpenAPI

````yaml bundled/audit-logs.yaml GET /audit_logs
openapi: 3.0.3
info:
  title: NeetoForm Audit Logs APIs
  version: 2.0.0
servers:
  - description: NeetoForm APIs
    url: https://{your-subdomain}.neetoform.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/api/workspace-subdomain).
security: []
tags:
  - name: Audit Logs
    description: APIs to read the audit logs of the workspace.
paths:
  /audit_logs:
    get:
      tags:
        - Audit Logs
      summary: List audit logs
      description: >-
        List the audit logs of the workspace, newest first. You can limit them
        to a date range. When `page_number` is omitted, all matching logs are
        returned.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - in: query
          name: created_after
          description: >-
            Only logs created at or after this time. Use an ISO 8601 date or
            date-time.
          required: false
          schema:
            type: string
            example: '2026-10-01'
        - in: query
          name: created_before
          description: >-
            Only logs created before this time. Use an ISO 8601 date or
            date-time.
          required: false
          schema:
            type: string
            example: '2026-10-28T00:00:00Z'
        - $ref: '#/components/parameters/page_number_all_results_param'
        - $ref: '#/components/parameters/page_size_param'
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/audit_log_list_response'
              example:
                audit_logs:
                  - id: 5e6f7a8b-9c0d-4e1f-2a3b-4c5d6e7f8a9b
                    key: audit_logs.organization.updated_user
                    metadata:
                      status: success
                      via: neetoform
                      email: sam@example.com
                      changes:
                        active:
                          from: false
                          to: true
                    created_at: '2026-10-27T08:30:00.000Z'
                    performer:
                      name: Oliver Smith
                      email: oliver@example.com
                pagination:
                  total_records: 1
                  total_pages: 1
                  current_page_number: 1
                  page_size: 30
        '422':
          description: Unprocessable Entity - A date filter is not valid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                error: >-
                  created_after must be an ISO 8601 date (YYYY-MM-DD) or
                  date-time.
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/api/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    page_number_all_results_param:
      in: query
      name: page_number
      description: >-
        Page of results to retrieve, starting from 1. When omitted, all results
        are returned in one response and `page_size` is ignored.
      required: false
      schema:
        type: integer
    page_size_param:
      in: query
      name: page_size
      description: Number of results per page. Defaults to 30 when omitted.
      required: false
      schema:
        type: integer
  schemas:
    audit_log_list_response:
      allOf:
        - type: object
          properties:
            audit_logs:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    example: 5e6f7a8b-9c0d-4e1f-2a3b-4c5d6e7f8a9b
                  key:
                    type: string
                    description: Name of the action that was logged.
                    example: audit_logs.organization.updated_user
                  metadata:
                    type: object
                    description: Details of the action. The fields depend on the action.
                    additionalProperties: true
                    example:
                      status: success
                      via: neetoform
                      email: sam.smith@example.com
                  created_at:
                    $ref: '#/components/schemas/date_time_field'
                  performer:
                    type: object
                    nullable: true
                    description: >-
                      The person who did the action. It is null when there is no
                      person.
                    properties:
                      name:
                        type: string
                        example: Oliver Smith
                      email:
                        type: string
                        example: oliver@example.com
        - $ref: '#/components/schemas/paginated_response'
    error_response:
      type: object
      properties:
        error:
          type: string
    date_time_field:
      type: string
      format: date-time
    paginated_response:
      type: object
      properties:
        pagination:
          type: object
          properties:
            total_records:
              type: integer
            total_pages:
              type: integer
            current_page_number:
              type: integer
            page_size:
              type: integer

````

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