> ## 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.

# Retrieve Case(s)

> Retrieving existing Case(s) using Query

<Info>
  **Note**: You may indicate specific queries by the rule, assignee, subject\_1, client\_subject\_id, caseStatus, bucket, id(case\_id), and/or client\_transaction\_id to filter down to specific cases.
</Info>

### Filterable Fields

* rule
* assignee
* subject\_1
* client\_subject\_id
* caseStatus
* bucket
* client\_transaction\_id

**Multiple fields** can be filtered at the **same time**. Fields can be linked as shown in the same request URL where rule and assignee are both used as the queries. The different queries can be joined by '&'

**Default Order By**

* case\_status\_order (1st)
* ageing (2nd)

**Optional Order By**

* priority
* created\_on
* ageing
* rule\_rule\_number\_id
* bucket\_id
* case\_status\_order
* assignee\_id


## OpenAPI

````yaml get /api/cases
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/cases:
    get:
      tags:
        - Case
      summary: List all cases
      description: Retrieve a list of all cases with optional filtering and ordering.
      operationId: case_list
      parameters:
        - in: query
          name: alert_risk_rating
          schema:
            type: string
        - in: query
          name: assignee
          schema:
            type: string
        - in: query
          name: bucket
          schema:
            type: string
        - in: query
          name: case_status
          schema:
            type: string
        - in: query
          name: client_subject_id
          schema:
            type: string
        - in: query
          name: client_transaction_id
          schema:
            type: string
        - in: query
          name: id
          schema:
            type: integer
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - in: query
          name: max_date
          schema:
            type: string
            format: date-time
        - in: query
          name: min_date
          schema:
            type: string
            format: date-time
        - name: offset
          required: false
          in: query
          description: The initial index from which to return the results.
          schema:
            type: integer
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - in: query
          name: rule
          schema:
            type: string
        - in: query
          name: subject_1
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCaseListList'
          description: ''
      security:
        - CustomAuthentication: []
        - cookieAuth: []
        - BearerAuth: []
components:
  schemas:
    PaginatedCaseListList:
      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:
            $ref: '#/components/schemas/CaseList'
    CaseList:
      type: object
      properties:
        ageing:
          type: integer
        priority:
          type: integer
        case_status_order:
          type: integer
        alert_date:
          type: string
        alert_risk_rating:
          type: string
        assignee:
          $ref: '#/components/schemas/CaseListAssignee'
        bucket:
          $ref: '#/components/schemas/CaseListBucket'
        case_action:
          type: string
        case_status:
          type: string
        case_subjects:
          $ref: '#/components/schemas/CaseListCaseSubjects'
        created_on:
          type: string
        id:
          type: integer
        rule:
          type: integer
        active_timestamp:
          type: string
          format: date-time
      required:
        - active_timestamp
        - ageing
        - alert_date
        - alert_risk_rating
        - assignee
        - bucket
        - case_action
        - case_status
        - case_status_order
        - case_subjects
        - created_on
        - id
        - priority
        - rule
    CaseListAssignee:
      type: object
      properties:
        id:
          type: integer
          nullable: true
        name:
          type: string
      required:
        - id
        - name
    CaseListBucket:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name
    CaseListCaseSubjects:
      type: object
      properties:
        subject_1:
          $ref: '#/components/schemas/CaseListCaseSubjectInfor'
        subject_2:
          $ref: '#/components/schemas/CaseListCaseSubjectInfor'
      required:
        - subject_1
    CaseListCaseSubjectInfor:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        client_subject_id:
          type: string
      required:
        - client_subject_id
        - id
        - name
  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

````