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

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

# TaskSearchModel

## 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:
    AssigneeDetails:
      type: object
      description: Assignee search criteria. When provided in task search, the service
        resolves matching users and filters tasks by their assignee partyIds.
      properties:
        firstName:
          type: string
          description: Assignee first name (search criterion).
          example: John
        lastName:
          type: string
          description: Assignee last name (search criterion).
          example: Doe
        email:
          type: string
          description: Assignee email address (search criterion).
          example: john.doe@example.com
        fullName:
          type: string
          description: Assignee full name (search criterion).
          example: John Doe
    CaseIdentifierModel:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    TaskSearchModel:
      type: object
      properties:
        process:
          type: string
          description: A list of processes to filter the search results.
        carriers:
          type: array
          description: The carrier associated with the task.
          items:
            type: string
        taskName:
          type: string
          description: Name of the task.
        taskType:
          type: string
          description: Task Type
        taskDetails:
          type: string
          description: Associated Task Details
        statuses:
          type: array
          description: A list of task statuses to filter the search results.
          items:
            type: string
        queues:
          type: array
          description: A list of queue associated with the task to filter the search
            results.
          items:
            type: string
        assigneePartyId:
          type: string
          description: Assignee Party task filter
        caseId:
          type: string
        escalated:
          type: boolean
          description: Escalated or Not escalated task filter
        carrier:
          type: string
        status:
          type: string
        queue:
          type: string
        taskCreatedOn:
          type: string
          description: The created date for the task range filter.
          format: date-time
        scheduledDate:
          type: string
          description: The scheduled date filter.
          format: date-time
        scheduledDateStart:
          type: string
          description: The scheduled start date for the scheduled date range filter.
          format: date-time
        scheduledDateEnd:
          type: string
          description: The scheduled end date for the scheduled date range filter.
          format: date-time
        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
        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
        assigneeDetails:
          description: Assignee search criteria. When provided in task search, the service
            resolves matching users and filters tasks by their assignee
            partyIds.
          type: object
          allOf:
            - $ref: "#/components/schemas/AssigneeDetails"
        identifiers:
          type: array
          description: A list of case identifier to search task.
          items:
            $ref: "#/components/schemas/CaseIdentifierModel"
        sortBy:
          type: string
          description: The field by which to sort the search results.
        sortDirection:
          type: string
          description: The direction to sort the search results, either ascending (asc) or
            descending (desc).
        offset:
          type: string
          description: The offset for pagination, indicating the starting point for the
            results.
        pageSize:
          type: string
          description: The maximum number of results to return.
```