Search Tasks
GET {{baseUrl}}/api/v1/tasks/search
This API searches for tasks in your help desk portal.
OAuth Scope
Desk.search.READDesk.activities.calls.READDesk.activities.events.READDesk.activities.READDesk.activities.tasks.READDesk.tasks.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | From index, starts from 0 | |
limit | string | No. of entities to fetch | |
departmentId | string | ID of the department from which the entity must be fetched if not passed then searches in permitted departments <br>exact match<br> | |
id | string | ID of the task <br>exact match<br> | |
subject | string | subject of the task in the help desk <br>wildcard search<br> | |
ticketNumber | string | ticket Number of the ticket that associated with the task <br>exact match<br> | |
status | string | status of the task <br>exact match<br> | |
priority | string | Priority of the task <br>exact match<br> | |
assigneeId | string | ID of the agent assigned to resolve the task <br>exact match<br> | |
_all | string | Search throughout the task <br>wildcard search<br> | |
customField1 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField2 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField3 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField4 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField5 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField6 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField7 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField8 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField9 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
customField10 | string | Custom field in the task <br>wildcard search<br> <br>empty check<br> <br>not empty check<br> | |
createdTimeRange | string | Key that filters tasks created in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z | |
modifiedTimeRange | string | Key that filters tasks modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z | |
dueDateRange | string | Key that filters tasks due in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, dueDateRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z | |
sortBy | string | SortBy can be: <br>relevance,<br> <br>modifiedTime,<br> <br>createdTime,<br> |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"modifiedTime":"2016-09-13T12:14:41.000Z","cf":{},"ticket":null,"subject":"Bug Fix #121","completedTime":null,"departmentId":"3000000007043","dueDate":"2016-09-19T12:27:26.000Z","creatorId":"3000000008692","description":null,"ownerId":"3000000054002","priority":"High","isCommented":false,"createdTime":"2016-08-14T08:27:26.000Z","assignee":{"firstName":"","lastName":"jade","photoURL":"https://contacts.zoho.com/file?t=user\u0026ID=10657727","emailId":"jade@zylker.com","id":"5000000009116","zuid":"10657727"},"id":"3000000054004","department":{"name":"Testing","id":"5000000007235"},"category":null,"ticketId":null,"status":"Not Started"}],"count":1}