---
title: "CasePageSearchCriteria"
url: "https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5/schemas/CasePageSearchCriteria"
---

> Full API specification: https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5.md

# CasePageSearchCriteria

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Case Management API
  version: 1.0.0
servers:
  - url: https://dev.api.zinnia.io/
    description: Dev Environment
  - url: https://qa.api.zinnia.io/
    description: QA Environment
  - url: https://uat.api.zinnia.io/
    description: UAT Environment
  - url: https://api.zinnia.io/
    description: PROD Environment
components:
  schemas:
    CaseSearchCriteria:
      type: object
      properties:
        policyNumber:
          type: string
          description: The policy number associated with the case.
          example: AU7654098
        ssn:
          type: string
          description: The ssn associated with the case.
          example: SSN-UTK-0078
        ownerFirstName:
          type: string
          description: The first name of the policy owner.
          example: Utkarsh
        ownerLastName:
          type: string
          description: The last name of the policy owner.
          example: Jain
        caseIds:
          type: array
          items:
            type: string
            description: A list of case IDs to filter the search results.
          example:
            - NB-12345678
        applicationType:
          type: string
          description: The application type of the policy.
          example: Digital
        isIncludeSecondary:
          type: boolean
          description: Indicates whether to include secondary cases in the search results.
          default: false
          example: false
        process:
          type: array
          description: A list of processes to filter the search results.
          items:
            type: string
          example:
            - New Business
        carrier:
          type: string
          description: The carrier associated with the case.
          example: CarrierName_1
        requestSubType:
          type: array
          description: A list of request subtypes to filter the search results.
          items:
            type: string
          example:
            - INTERNAL CONVERSION
        productName:
          type: array
          description: A list of product names to filter the search results.
          items:
            type: string
          example:
            - TOTAL INTEREST ANUITY APPLICATION
        caseStatus:
          type: array
          description: A list of case statuses to filter the search results.
          items:
            type: string
          example:
            - Exception
        notInCaseStatus:
          type: array
          description: A list of case statuses to exclude from the search results.
          items:
            type: string
          example:
            - Exception
        createdDateStart:
          type: string
          description: The start date for the creation date range filter.
          format: date-time
        createdDateEnd:
          type: string
          format: date-time
          description: The end date for the creation date range filter.
        updatedDateStart:
          type: string
          format: date-time
          description: The start date for the updated date range filter.
        updatedDateEnd:
          type: string
          format: date-time
          description: The end date for the updated date range filter.
        agentFirstName:
          type: string
          description: The first name of the agent associated with the case.
          example: JOHN WESLY
        agentLastName:
          type: string
          description: The last name of the agent associated with the case.
          example: BEVAN
        brokerDealerName:
          type: string
          description: The name of the broker-dealer associated with the case.
          example: JP MORGAN SECURITIES LLC
        identifiers:
          type: array
          description: A list of case identifier to search case.
          items:
            type: object
            properties:
              identifier:
                type: string
                description: identifier name
                example: documentNumber
              value:
                type: string
                description: identifier value
                example: 20240813-EM-964334
          example:
            - identifier: documentNumber
              value: 20240813-EM-964334
        exceptions:
          type: array
          description: A list of exception filters to narrow case search results.
          items:
            $ref: "#/components/schemas/ExceptionFilterModel"
    ExceptionFilterModel:
      type: object
      properties:
        exceptionType:
          type: string
          description: Exception type filter.
        status:
          type: string
          description: Exception status filter.
        category:
          type: string
          description: Exception category filter.
    CasePageSearchCriteria:
      allOf:
        - $ref: "#/components/schemas/CaseSearchCriteria"
        - type: object
          properties:
            sortBy:
              type: string
              description: The field by which to sort the search results.
              enum:
                - updatedAt
                - createdAt
                - carrier
                - process
                - caseStatus
              example: createdAt
            sortDirection:
              type: string
              description: The direction to sort the search results, either ascending (asc) or
                descending (desc).
              enum:
                - asc
                - desc
            offset:
              type: integer
              format: int32
              description: The offset for pagination, indicating the starting point for the
                results.
              example: 2
            limit:
              type: integer
              format: int32
              description: The maximum number of results to return.
              example: 20
```