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

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the events must be fetched, starts from 0
limitstringNumber of events to fetch
departmentIdstringID 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>
idstringID of the event <br>exact match<br>
subjectstringSubject of the event <br>wildcard search<br>
ticketNumberstringTicket number of the ticket associated with the event <br>exact match<br>
statusstringStatus of the event <br>exact match<br>
prioritystringPriority of the event <br>exact match<br>
assigneeIdstringID of the agent assigned to handle the event <br>exact match<br>
_allstringKey that includes all event details for the search <br>wildcard search<br>
customField1stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField2stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField3stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField4stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField5stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField6stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField7stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField8stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField9stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
customField10stringCustom field in the event <br>wildcard search<br> <br>empty check<br> <br>not empty check<br>
createdTimeRangestringKey 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
modifiedTimeRangestringKey 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
startDateRangestringKey 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
sortBystringSortBy can be: <br>relevance,<br> <br>modifiedTime,<br> <br>createdTime,<br>

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;modifiedTime&quot;:&quot;2016-07-26T17:32:11.000Z&quot;,&quot;ticket&quot;:{&quot;ticketNumber&quot;:&quot;101&quot;,&quot;contact&quot;:{&quot;firstName&quot;:null,&quot;lastName&quot;:&quot;Lawrence&quot;,&quot;id&quot;:&quot;3000000008749&quot;},&quot;id&quot;:&quot;3000000008753&quot;},&quot;customFields&quot;:{},&quot;subject&quot;:&quot;New Event&quot;,&quot;completedTime&quot;:&quot;2016-07-26T17:32:11.000Z&quot;,&quot;departmentId&quot;:&quot;3000000007043&quot;,&quot;creatorId&quot;:&quot;3000000008692&quot;,&quot;description&quot;:null,&quot;ownerId&quot;:null,&quot;priority&quot;:&quot;Normal&quot;,&quot;duration&quot;:&quot;30&quot;,&quot;createdTime&quot;:&quot;2016-07-26T16:32:11.000Z&quot;,&quot;startTime&quot;:&quot;2016-07-26T17:02:11.000Z&quot;,&quot;id&quot;:&quot;3000000018001&quot;,&quot;assignee&quot;:{&quot;firstName&quot;:&quot;&quot;,&quot;lastName&quot;:&quot;raja&quot;,&quot;photoURL&quot;:null,&quot;emailId&quot;:&quot;carol@zylker.com&quot;,&quot;id&quot;:&quot;36385000000120033&quot;,&quot;zuid&quot;:&quot;55499215&quot;},&quot;category&quot;:&quot;Meeting&quot;,&quot;ticketId&quot;:&quot;3000000008753&quot;,&quot;status&quot;:&quot;completed&quot;}],&quot;count&quot;:1}