Tickets Search API

GET {{baseUrl}}/api/v1/tickets/search

This API searches for tickets in your help desk. The values can be given comma separated, which denotes the search on the field is done using either of the values given.

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.

CustomField param Example:
customField1=cf_modelName:F3
customField2=cfphone:902*
customField3=cfpermanentAddress: Wall Street

Note:
wildcard match will not be available for the custom fields that are not of type string
Wildcard character question mark (?) is not supported
mobile and phone fields supports asterisk () at the beginning

Urlencoded Example:
customField1=cfmodelName%3AF3*
customField2=cfphone%3A902
customField3=cf_permanentAddress%3AWall%20Street
For empty check: email=%24%7Bempty%7D

OAuth Scope

• Desk.search.READ
• Desk.tickets.READ

Request Params

HEADERS

RESPONSES

status: OK

{"data":[{"modifiedTime":"2016-06-21T13:16:14.000Z","ticketNumber":"101","subCategory":"Sub General","statusType":"Open","subject":"Hi. There is a sudden delay in the processing of the orders. Check this with high priority","dueDate":"2016-06-21T16:16:16.000Z","departmentId":"1892000000006907","isRead":false,"channel":"FORUMS","onholdTime":null,"description":"Hi. There is a sudden delay in the processing of the orders. Check this with high priority","resolution":null,"sharedDepartments":[{"name":"Sample Department Name","id":"1892000000006909","type":"READ_WRITE"},{"name":"Sample Department Name","id":"1892000000006911","type":"READ_ONLY"}],"closedTime":null,"isOverDue":false,"contact":{"lastName":"Carol","firstName":"Lucas","phone":"1 888 900 9646","mobile":"9876543456","id":"1892000000042032","type":null,"email":"carol@zylker.com","account":{"website":"www.desk.com","accountName":"desk Account","id":"1892000000975382"}},"createdTime":"2013-11-04T11:21:07.000Z","modifiedBy":"52338000000043001","id":"1892000000042034","department":{"name":"dasdasdasd","id":"1892000000006907"},"email":"carol@zylker.com","customerResponseTime":"2013-11-04T11:21:07.912Z","product":null,"cf":{"cf_permanentaddress":null,"cf_dateofpurchase":null,"cf_phone":null,"cf_numberofitems":null,"cf_url":null,"cf_secondaryemail":null,"cf_severitypercentage":"0.0","cf_modelname":"F3 2017"},"productId":null,"contactId":"1892000000042032","threadCount":"121","lastThread":{"channel":"FEEDBACK","isDraft":false,"isForward":false,"direction":"in"},"team":{"name":"kjsdfjks","id":"8920000000069071"},"priority":"High","classification":null,"assigneeId":"1892000000056007","commentCount":"1","phone":"1 888 900 9646","createdBy":"52338000000043001","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38","teamId":"8920000000069071","isEscalated":false,"isSpam":false,"assignee":{"firstName":"dasca","lastName":"vins","photoURL":"https://desk.zoho.com/api/v1/agents/1892000000056007/photo?orgId=298902","emailId":"jack@zylker.com","id":"1892000000056007","zuid":"640954748"},"category":"general","status":"Open"}],"count":1}