> ## Documentation Index
> Fetch the complete documentation index at: https://omniflow-vpn.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get v1panelaudit

> Requires audit.read. The trail is append-only and exposes reads only.



## OpenAPI

````yaml https://raw.githubusercontent.com/kewldan/omniflow/main/api/openapi.yaml get /v1/panel/audit
openapi: 3.0.3
info:
  title: Omniflow API
  version: 1.0.0
  description: >-
    Customer, commerce, payment, wallet, fulfillment, and operations API for
    Omniflow.
servers: []
security: []
paths:
  /v1/panel/audit:
    get:
      tags:
        - panel
      description: Requires audit.read. The trail is append-only and exposes reads only.
      operationId: searchPanelAudit
      parameters:
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/PageSize'
        - in: query
          name: category
          schema:
            $ref: '#/components/schemas/AuditCategory'
        - in: query
          name: outcome
          schema:
            $ref: '#/components/schemas/AuditOutcome'
        - in: query
          name: actorType
          schema:
            type: string
        - in: query
          name: actorId
          schema:
            type: string
        - in: query
          name: action
          schema:
            type: string
        - in: query
          name: targetType
          schema:
            type: string
        - in: query
          name: targetId
          schema:
            type: string
        - in: query
          name: from
          schema:
            type: string
            format: date-time
        - in: query
          name: to
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Audit events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditPage'
        '403':
          $ref: '#/components/responses/Problem'
components:
  parameters:
    Cursor:
      in: query
      name: cursor
      schema:
        type: string
        description: Opaque keyset cursor from the previous page.
    PageSize:
      in: query
      name: pageSize
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 100
  schemas:
    AuditCategory:
      type: string
      enum:
        - authentication
        - authorization
        - configuration
        - customer
        - financial
        - support
        - marketing
        - system
    AuditOutcome:
      type: string
      enum:
        - success
        - failure
        - denied
    AuditPage:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AuditEvent'
        nextCursor:
          type: string
    AuditEvent:
      type: object
      required:
        - id
        - occurredAt
        - actorType
        - action
        - category
        - outcome
        - targetType
        - targetId
      properties:
        id:
          type: string
          format: uuid
        occurredAt:
          type: string
          format: date-time
        actorType:
          type: string
          enum:
            - customer
            - operator
            - admin
            - system
            - provider
        actorId:
          type: string
        action:
          type: string
        category:
          $ref: '#/components/schemas/AuditCategory'
        outcome:
          $ref: '#/components/schemas/AuditOutcome'
        targetType:
          type: string
        targetId:
          type: string
        reason:
          type: string
        requestId:
          type: string
        metadata:
          type: object
          additionalProperties: true
          description: Safe before/after context. Never a secret.
    Problem:
      type: object
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        request_id:
          type: string
  responses:
    Problem:
      description: Request failed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'

````

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