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

# List all Whitelist records



## OpenAPI

````yaml get /api/whitelist
openapi: 3.0.3
info:
  title: Athena API
  version: v3
  x-logo:
    url: https://cynopsis.co/wp-content/uploads/2021/03/logo-2.png
    altText: Cynopsis Solutions
  description: >-
    ATHENA is an advanced real-time transaction monitoring solution designed to
    detect and prevent money laundering, fraud, and terrorism financing. Powered
    by proprietary AML rules, ATHENA analyzes transactions in real time,
    providing clear, intuitive visual insights to streamline compliance
    processes.
        
        ✅ Real-Time Monitoring – Instantly analyzes transaction data to detect anomalies and potential compliance risks.
        ✅ Visualized Insights – Converts complex data into easy-to-understand charts, aiding faster decision-making.
        ✅ Seamless Integration – Easily integrates with existing financial and compliance systems.
        
        Ideal for financial institutions, fintech companies, and regulated businesses, ATHENA enhances risk management and ensures regulatory compliance with ease.
  contact:
    email: tech@cynopsis.co
servers:
  - url: http://localhost/api
    description: Local development server
security: []
paths:
  /api/whitelist:
    get:
      tags:
        - Whitelist
      summary: List all Whitelist records
      operationId: whitelist_list
      parameters:
        - in: query
          name: bucket
          schema:
            type: string
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - name: offset
          required: false
          in: query
          description: The initial index from which to return the results.
          schema:
            type: integer
        - in: query
          name: rules
          schema:
            type: string
        - in: query
          name: subject
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - results
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                    format: uri
                    example: http://api.example.org/accounts/?offset=400&limit=100
                  previous:
                    type: string
                    nullable: true
                    format: uri
                    example: http://api.example.org/accounts/?offset=200&limit=100
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of items
                        next:
                          type: string
                          nullable: true
                          description: URL for next page
                        previous:
                          type: string
                          nullable: true
                          description: URL for previous page
                        results:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                description: Whitelist record ID
                              rules:
                                type: array
                                items:
                                  type: integer
                                description: List of rule IDs
                              bucket:
                                type: string
                                description: Bucket identifier
                              subject:
                                type: string
                                description: Subject identifier
                              created_at:
                                type: string
                                format: date-time
                                description: Creation timestamp
                              updated_at:
                                type: string
                                format: date-time
                                description: Last update timestamp
                              created_by:
                                type: integer
                                description: ID of user who created the record
                              modified_by:
                                type: integer
                                description: ID of user who last modified the record
                            required:
                              - id
                            description: Whitelist object with all details
                          description: List of whitelist records
                      description: Paginated whitelist list
          description: Whitelist records
      security:
        - CustomAuthentication: []
        - cookieAuth: []
        - BearerAuth: []
components:
  securitySchemes:
    CustomAuthentication:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from AWS Cognito or custom authentication service
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid

````