List tickets by CRMType

GET {{baseUrl}}/api/v1/ticketsByCrmContactType?crmContactType=<string> max chars : 100

This API lists tickets in OPEN and ON HOLD state by contact types as categorized in Zoho CRM.

OAuth Scope

  • Desk.tickets.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the tickets must be listed
limitstringNumber of tickets to fetch
departmentIdstringID of the department from which the tickets must be fetched
crmContactTypestringContact type as set in Zoho CRM. Values allowed are unmapped, contacts_leads, potentials, and customers
includestringAdditional information related to the tickets. Values allowed are:&nbsp;contacts,&nbsp;products, departments,&nbsp;team,&nbsp;isRead and assignee. You can pass multiple values by separating them with commas in the API request.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;ticketNumber&quot;:&quot;101&quot;,&quot;subCategory&quot;:null,&quot;statusType&quot;:&quot;Open&quot;,&quot;subject&quot;:&quot;Hi. There is a sudden delay in the processing of the orders. Check this with high priority&quot;,&quot;dueDate&quot;:&quot;2016-06-21T16:16:16.000Z&quot;,&quot;departmentId&quot;:&quot;1892000000006907&quot;,&quot;channel&quot;:&quot;Email&quot;,&quot;isRead&quot;:true,&quot;onholdTime&quot;:null,&quot;language&quot;:&quot;English&quot;,&quot;closedTime&quot;:null,&quot;sharedCount&quot;:&quot;0&quot;,&quot;contact&quot;:{&quot;lastName&quot;:&quot;Carol&quot;,&quot;firstName&quot;:&quot;Lucas&quot;,&quot;phone&quot;:&quot;1 888 900 9646&quot;,&quot;mobile&quot;:&quot;8834567908&quot;,&quot;id&quot;:&quot;1892000000042032&quot;,&quot;type&quot;:null,&quot;email&quot;:&quot;carol@zylker.com&quot;,&quot;account&quot;:{&quot;website&quot;:&quot;www.desk.com&quot;,&quot;accountName&quot;:&quot;desk Account&quot;,&quot;id&quot;:&quot;1892000000975382&quot;}},&quot;createdTime&quot;:&quot;2013-11-04T11:21:07.000Z&quot;,&quot;id&quot;:&quot;1892000000042034&quot;,&quot;department&quot;:{&quot;name&quot;:&quot;dasdasdasd&quot;,&quot;id&quot;:&quot;1892000000006907&quot;},&quot;email&quot;:&quot;carol@zylker.com&quot;,&quot;customerResponseTime&quot;:&quot;2013-11-04T11:21:07.912Z&quot;,&quot;productId&quot;:null,&quot;contactId&quot;:&quot;1892000000042032&quot;,&quot;threadCount&quot;:&quot;121&quot;,&quot;team&quot;:{&quot;name&quot;:&quot;kjsdfjks&quot;,&quot;id&quot;:&quot;8920000000069071&quot;},&quot;priority&quot;:&quot;High&quot;,&quot;assigneeId&quot;:&quot;1892000000056007&quot;,&quot;commentCount&quot;:&quot;1&quot;,&quot;phone&quot;:null,&quot;webUrl&quot;:&quot;https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38&quot;,&quot;teamId&quot;:&quot;8920000000069071&quot;,&quot;isSpam&quot;:false,&quot;assignee&quot;:{&quot;firstName&quot;:&quot;dasca&quot;,&quot;lastName&quot;:&quot;vins&quot;,&quot;photoURL&quot;:&quot;https://desk.zoho.com/api/v1/agents/1892000000056007/photo?orgId=298902&quot;,&quot;id&quot;:&quot;1892000000056007&quot;,&quot;email&quot;:&quot;jack@zylker.com&quot;},&quot;category&quot;:null,&quot;status&quot;:&quot;Open&quot;},{&quot;ticketNumber&quot;:&quot;169&quot;,&quot;subCategory&quot;:null,&quot;statusType&quot;:&quot;On Hold&quot;,&quot;subject&quot;:&quot;Hi. There is a sudden delay in the processing of the orders. Check this with high priority&quot;,&quot;dueDate&quot;:null,&quot;departmentId&quot;:&quot;1892000000006907&quot;,&quot;isRead&quot;:true,&quot;channel&quot;:&quot;Facebook&quot;,&quot;onholdTime&quot;:&quot;2014-03-06T11:34:53.000Z&quot;,&quot;closedTime&quot;:null,&quot;sharedCount&quot;:&quot;0&quot;,&quot;contact&quot;:{&quot;lastName&quot;:&quot;Lawrence&quot;,&quot;firstName&quot;:&quot;Jonathan&quot;,&quot;phone&quot;:&quot;1 888 900 9646&quot;,&quot;mobile&quot;:&quot;8812345608&quot;,&quot;id&quot;:&quot;1892000000042032&quot;,&quot;type&quot;:null,&quot;email&quot;:&quot;lawrence@zylker.com&quot;,&quot;account&quot;:{&quot;website&quot;:null,&quot;accountName&quot;:&quot;desk Account&quot;,&quot;id&quot;:&quot;1892000000975382&quot;}},&quot;createdTime&quot;:&quot;2014-03-06T09:34:53.000Z&quot;,&quot;id&quot;:&quot;1892000000093205&quot;,&quot;department&quot;:{&quot;name&quot;:&quot;dasdasdasd&quot;,&quot;id&quot;:&quot;1892000000006907&quot;},&quot;email&quot;:&quot;lawrence@zylker.com&quot;,&quot;customerResponseTime&quot;:&quot;2014-03-11T07:51:29.618Z&quot;,&quot;productId&quot;:null,&quot;contactId&quot;:&quot;1892000000093203&quot;,&quot;threadCount&quot;:&quot;43&quot;,&quot;team&quot;:{&quot;name&quot;:&quot;kjsdfjks&quot;,&quot;id&quot;:&quot;8920000000069071&quot;},&quot;priority&quot;:null,&quot;assigneeId&quot;:&quot;1892000000042001&quot;,&quot;commentCount&quot;:&quot;0&quot;,&quot;phone&quot;:null,&quot;webUrl&quot;:&quot;https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebbcaefeb9d93ba74750b02843cad3b38&quot;,&quot;teamId&quot;:&quot;8920000000069071&quot;,&quot;isSpam&quot;:false,&quot;assignee&quot;:{&quot;firstName&quot;:&quot;dasca&quot;,&quot;lastName&quot;:&quot;vins&quot;,&quot;photoURL&quot;:&quot;https://desk.zoho.com/api/v1/agents/1892000000042001/photo?orgId=298902&quot;,&quot;id&quot;:&quot;1892000000042001&quot;,&quot;email&quot;:&quot;jack@zylker.com&quot;},&quot;category&quot;:null,&quot;status&quot;:&quot;On Hold&quot;}]}