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

# Query audit logs

> Returns paginated audit logs with optional filters for security and compliance monitoring



## OpenAPI

````yaml /api-reference/openapi.json get /admin/audit-logs
openapi: 3.0.0
info:
  title: EngageFabric API
  description: >-
    EngageFabric is a multi-tenant SaaS gamification framework. This API
    provides endpoints for managing players, tracking events, quests,
    adventures, leaderboards, lobbies, and real-time features.
  version: 1.0.0
  contact:
    name: EngageFabric Support
    url: https://engagefabric.com
    email: support@engagefabric.com
  license:
    name: Proprietary
    url: https://engagefabric.com/terms
servers:
  - url: https://api.engagefabric.com
    description: Production
  - url: http://localhost:3000
    description: Development
security: []
tags:
  - name: auth
    description: Authentication endpoints
  - name: tenants
    description: Tenant management
  - name: projects
    description: Project management
  - name: players
    description: Player management and game state
  - name: events
    description: Event ingestion and tracking
  - name: quests
    description: Quest management and progress
  - name: adventures
    description: Adventure/season management
  - name: leaderboards
    description: Leaderboard rankings
  - name: lobbies
    description: Multiplayer lobby management
  - name: chat
    description: Real-time chat
  - name: rules
    description: Rules engine configuration
paths:
  /admin/audit-logs:
    get:
      tags:
        - Admin - Audit Logs
      summary: Query audit logs
      description: >-
        Returns paginated audit logs with optional filters for security and
        compliance monitoring
      operationId: AuditLogController_queryLogs
      parameters:
        - name: tenantId
          required: false
          in: query
          description: Filter by tenant ID
          schema:
            type: string
        - name: projectId
          required: false
          in: query
          description: Filter by project ID
          schema:
            type: string
        - name: actorType
          required: false
          in: query
          description: Filter by actor type
          schema:
            type: string
            enum:
              - USER
              - API_KEY
              - SYSTEM
              - WEBHOOK
              - PLAYER
        - name: actorId
          required: false
          in: query
          description: Filter by actor ID
          schema:
            type: string
        - name: eventType
          required: false
          in: query
          description: Filter by event type
          schema:
            type: string
            enum:
              - AUTH_LOGIN
              - AUTH_LOGOUT
              - AUTH_FAILED_LOGIN
              - AUTH_TOKEN_CREATED
              - AUTH_TOKEN_REVOKED
              - TENANT_CREATED
              - TENANT_UPDATED
              - TENANT_DELETED
              - PROJECT_CREATED
              - PROJECT_UPDATED
              - PROJECT_DELETED
              - PROJECT_TIER_CHANGED
              - PLAYER_CREATED
              - PLAYER_UPDATED
              - PLAYER_DELETED
              - PLAYER_BANNED
              - PLAYER_UNBANNED
              - XP_GRANTED
              - LEVEL_UP
              - CURRENCY_GRANTED
              - CURRENCY_DEDUCTED
              - BADGE_AWARDED
              - LIVES_UPDATED
              - RULE_CREATED
              - RULE_UPDATED
              - RULE_DELETED
              - RULE_PUBLISHED
              - RULE_EXECUTED
              - QUEST_CREATED
              - QUEST_UPDATED
              - QUEST_COMPLETED
              - ADVENTURE_CREATED
              - ADVENTURE_STARTED
              - ADVENTURE_COMPLETED
              - RATE_LIMIT_EXCEEDED
              - RATE_LIMIT_RESET
              - RATE_LIMIT_OVERRIDE_CREATED
              - IP_BLOCKED
              - IP_UNBLOCKED
              - ABUSE_DETECTED
              - ADMIN_OVERRIDE
              - ADMIN_DATA_EXPORT
              - ADMIN_CONFIG_CHANGE
              - ADMIN_MANUAL_ADJUSTMENT
              - SECURITY_SUSPICIOUS_ACTIVITY
              - SECURITY_API_KEY_LEAKED
              - SECURITY_UNAUTHORIZED_ACCESS
              - SECURITY_IP_BLOCKED
              - SECURITY_IP_UNBLOCKED
        - name: eventCategory
          required: false
          in: query
          description: Filter by event category
          schema:
            type: string
            enum:
              - AUTHENTICATION
              - AUTHORIZATION
              - DATA_ACCESS
              - DATA_MUTATION
              - CONFIGURATION
              - SECURITY
              - COMPLIANCE
              - ADMIN_ACTION
              - SYSTEM_EVENT
        - name: resource
          required: false
          in: query
          description: Filter by resource type
          schema:
            type: string
        - name: resourceId
          required: false
          in: query
          description: Filter by resource ID
          schema:
            type: string
        - name: severity
          required: false
          in: query
          description: Filter by severity
          schema:
            type: string
            enum:
              - DEBUG
              - INFO
              - WARNING
              - ERROR
              - CRITICAL
        - name: suspiciousOnly
          required: false
          in: query
          description: Filter suspicious only
          schema:
            default: false
            type: boolean
        - name: startDate
          required: false
          in: query
          description: Start date (ISO 8601)
          schema:
            type: string
        - name: endDate
          required: false
          in: query
          description: End date (ISO 8601)
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: Page number
          schema:
            minimum: 1
            default: 1
            type: number
        - name: limit
          required: false
          in: query
          description: Items per page
          schema:
            minimum: 1
            maximum: 100
            default: 50
            type: number
      responses:
        '200':
          description: Paginated audit logs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAuditLogsDto'
      security:
        - bearer: []
components:
  schemas:
    PaginatedAuditLogsDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AuditLogDto'
        total:
          type: number
        page:
          type: number
        limit:
          type: number
        totalPages:
          type: number
      required:
        - items
        - total
        - page
        - limit
        - totalPages
    AuditLogDto:
      type: object
      properties:
        id:
          type: string
        tenantId:
          type: string
        projectId:
          type: string
        actorType:
          type: string
          enum:
            - USER
            - API_KEY
            - SYSTEM
            - WEBHOOK
            - PLAYER
        actorId:
          type: string
        actorIp:
          type: string
        eventType:
          type: string
          enum:
            - AUTH_LOGIN
            - AUTH_LOGOUT
            - AUTH_FAILED_LOGIN
            - AUTH_TOKEN_CREATED
            - AUTH_TOKEN_REVOKED
            - TENANT_CREATED
            - TENANT_UPDATED
            - TENANT_DELETED
            - PROJECT_CREATED
            - PROJECT_UPDATED
            - PROJECT_DELETED
            - PROJECT_TIER_CHANGED
            - PLAYER_CREATED
            - PLAYER_UPDATED
            - PLAYER_DELETED
            - PLAYER_BANNED
            - PLAYER_UNBANNED
            - XP_GRANTED
            - LEVEL_UP
            - CURRENCY_GRANTED
            - CURRENCY_DEDUCTED
            - BADGE_AWARDED
            - LIVES_UPDATED
            - RULE_CREATED
            - RULE_UPDATED
            - RULE_DELETED
            - RULE_PUBLISHED
            - RULE_EXECUTED
            - QUEST_CREATED
            - QUEST_UPDATED
            - QUEST_COMPLETED
            - ADVENTURE_CREATED
            - ADVENTURE_STARTED
            - ADVENTURE_COMPLETED
            - RATE_LIMIT_EXCEEDED
            - RATE_LIMIT_RESET
            - RATE_LIMIT_OVERRIDE_CREATED
            - IP_BLOCKED
            - IP_UNBLOCKED
            - ABUSE_DETECTED
            - ADMIN_OVERRIDE
            - ADMIN_DATA_EXPORT
            - ADMIN_CONFIG_CHANGE
            - ADMIN_MANUAL_ADJUSTMENT
            - SECURITY_SUSPICIOUS_ACTIVITY
            - SECURITY_API_KEY_LEAKED
            - SECURITY_UNAUTHORIZED_ACCESS
            - SECURITY_IP_BLOCKED
            - SECURITY_IP_UNBLOCKED
        eventCategory:
          type: string
          enum:
            - AUTHENTICATION
            - AUTHORIZATION
            - DATA_ACCESS
            - DATA_MUTATION
            - CONFIGURATION
            - SECURITY
            - COMPLIANCE
            - ADMIN_ACTION
            - SYSTEM_EVENT
        action:
          type: string
        resource:
          type: string
        resourceId:
          type: string
        details:
          type: object
        changes:
          type: object
        metadata:
          type: object
        status:
          type: string
          enum:
            - SUCCESS
            - FAILURE
            - PARTIAL
        errorMessage:
          type: string
        severity:
          type: string
          enum:
            - DEBUG
            - INFO
            - WARNING
            - ERROR
            - CRITICAL
        isSuspicious:
          type: boolean
        flagReason:
          type: string
        createdAt:
          format: date-time
          type: string
      required:
        - id
        - actorType
        - actorId
        - eventType
        - eventCategory
        - action
        - resource
        - status
        - severity
        - isSuspicious
        - createdAt

````