Event Search API
GET {{baseUrl}}/api/v1/events/search
This API searches for events in your help desk portal. You can pass multiple values by separating them with commas, which denotes the search on the field is done using any of the values passed.
Zoho Desk APIs support two types of search:exact match and wildcard match.
exact match returns resources only if the value passed exactly matches with a resource in the help desk.
wildcard match returns resources even if the value passed partially matches with a resource in the help desk.
To perform wildcard match, append an asterisk (*) after the value to search.
OAuth Scope
Desk.search.READ
Desk.events.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
from | string | Index number, starting from which the events must be fetched, starts from 0 | |
limit | string | Number of events to fetch | |
departmentId | string | ID of the department from which the event must be fetched. If a valid ID is not passed, the search is performed in all departments permitted. <br>exact match <br> | |
id | string | ID of the event <br>exact match <br> | |
subject | string | Subject of the event <br>wildcard search <br> | |
ticketNumber | string | Ticket number of the ticket associated with the event <br>exact match <br> | |
status | string | Status of the event <br>exact match <br> | |
priority | string | Priority of the event <br>exact match <br> | |
assigneeId | string | ID of the agent assigned to handle the event <br>exact match <br> | |
_all | string | Key that includes all event details for the search <br>wildcard search <br> | |
customField1 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
customField2 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
customField3 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
customField4 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
customField5 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
customField6 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
customField7 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
customField8 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
customField9 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
customField10 | string | Custom field in the event <br>wildcard search <br> <br>empty check <br> <br>not empty check <br> | |
createdTimeRange | string | Key that filters events recorded in the help desk in a particular period. 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 events whose details were modified in a particular period. 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 | |
startDateRange | string | Key that filters events that occurred in a particular period. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, startDateRange=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-07-26T17:32:11.000Z","ticket":{"ticketNumber":"101","contact":{"firstName":null,"lastName":"Lawrence","id":"3000000008749"},"id":"3000000008753"},"customFields":{},"subject":"New Event","completedTime":"2016-07-26T17:32:11.000Z","departmentId":"3000000007043","creatorId":"3000000008692","description":null,"ownerId":null,"priority":"Normal","duration":"30","createdTime":"2016-07-26T16:32:11.000Z","startTime":"2016-07-26T17:02:11.000Z","id":"3000000018001","assignee":{"firstName":"","lastName":"raja","photoURL":null,"emailId":"carol@zylker.com","id":"36385000000120033","zuid":"55499215"},"category":"Meeting","ticketId":"3000000008753","status":"completed"}],"count":1}