List all tickets
GET {{baseUrl}}/api/v1/tickets
This API lists a particular number of tickets, based on the limit specified.
OAuth Scope
Desk.tickets.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | Index number, starting from which the tickets must be fetched | |
limit | string | Number of tickets to fetch | |
departmentId | string | ID of the department from which the tickets must be fetched (Please note that this key will be deprecated soon and replaced by the <b>departmentIds</b> key.) | |
departmentIds | string | Departments from which the tickets need to be queried | |
viewId | string | ID of the view to apply while fetching the resources | |
assignee | string | assignee - Key that filters tickets by assignee. Values allowed are Unassigned or a valid assigneeId. Multiple assigneeIds can be passed as comma-separated values. | |
channel | string | Filter by channel through which the tickets originated. You can include multiple values by separating them with a comma | |
status | string | Filter by resolution status of the ticket. You can include multiple values by separating them with a comma | |
sortBy | string | Sort by a specific attribute: responseDueDate or customerResponseTime or createdTime or ticketNumber. The default sorting order is ascending. A - prefix denotes descending order of sorting. | |
receivedInDays | string | Fetches recent tickets, based on customer response time. Values allowed are 15, 30 , 90. | |
include | string | Additional information related to the tickets. Values allowed are: contacts, products, departments, team, isRead and assignee. You can pass multiple values by separating them with commas in the API request. | |
fields | string | Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: statusType, webUrl, layoutId. Maximum of 30 fields is supported as comma separated values. | |
priority | string | Key that filters tickets by priority. Multiple priority levels can be passed as comma-separated values. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"ticketNumber":"101","subCategory":null,"subject":"Real Time analysis Requirement","dueDate":"2016-06-21T16:16:16.000Z","departmentId":"1892000000006907","channel":"Email","isRead":false,"onholdTime":null,"language":"English","source":{"appName":null,"extId":null,"type":"SYSTEM","permalink":null,"appPhotoURL":null},"closedTime":null,"sharedCount":"0","responseDueDate":"2017-09-05T11:21:07.000Z","contact":{"firstName":"Lucas","lastName":"Carol","phone":"1 888 900 9646","mobile":"9876543210","id":"1892000000042032","type":null,"email":"carol@zylker.com","account":{"website":null,"accountName":"desk Account","id":"1892000000975382"}},"createdTime":"2013-11-04T11:21:07.000Z","id":"1892000000042034","department":{"name":"dasdasdasd","id":"1892000000006907"},"email":"carol@zylker.com","channelCode":null,"customerResponseTime":"2013-11-04T11:21:07.912Z","productId":null,"contactId":"1892000000042032","threadCount":"121","team":{"name":"kjsdfjks","id":"8920000000069071"},"priority":"High","assigneeId":"1892000000056007","commentCount":"1","phone":null,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38","teamId":"8920000000069071","assignee":{"firstName":"dasca","lastName":"vins","photoURL":"https://desk.zoho.com/api/v1/agents/1892000000056007/photo?orgId=298902","id":"1892000000056007","email":"jack@zylker.com"},"isSpam":false,"category":null,"status":"Open"},{"ticketNumber":"176","subCategory":null,"statusType":"Closed","subject":"Hi. There is a sudden delay in the processing of the orders. Check this with high priority","dueDate":"2016-06-01T14:04:07.000Z","departmentId":"1892000000006907","channel":"Forums","isRead":false,"onholdTime":null,"source":{"appName":null,"extId":null,"type":"SYSTEM","permalink":null,"appPhotoURL":null},"closedTime":null,"sharedCount":"0","responseDueDate":null,"contact":{"firstName":"Jonathan","lastName":"Casie","phone":null,"mobile":"9876543211","id":"1892000000045028","type":null,"email":"casie@zylker.com","account":{"website":"www.zylker.com","accountName":"Zylker sAccount","id":"1892000000980421"}},"createdTime":"2014-03-06T09:49:50.000Z","id":"1892000000094004","department":{"name":"dasdasdasd","id":"1892000000006907"},"email":"casie@zylker.com","channelCode":null,"customerResponseTime":"2014-03-22T05:05:08.471Z","productId":null,"contactId":"1892000000045028","threadCount":"72","team":{"name":"kjsdfjks","id":"8920000000069071"},"priority":"High","assigneeId":"1892000000056007","commentCount":"0","phone":null,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebddaeb9d93ba74750b02214oc203b38","teamId":"8920000000069071","isSpam":false,"assignee":{"firstName":"dasca","lastName":"vins","photoURL":"https://desk.zoho.com/api/v1/agents/1892000000056007/photo?orgId=298902","id":"1892000000056007","email":"jack@zylker.com"},"category":null,"status":"Closed"},{"ticketNumber":"191","subCategory":null,"statusType":"On Hold","subject":"Real Time analysis Requirement","dueDate":null,"departmentId":"1892000000006907","channel":"Chat","isRead":true,"onholdTime":"2014-03-28T12:09:10.736Z","source":{"appName":null,"extId":null,"type":"SYSTEM","permalink":null,"appPhotoURL":null},"closedTime":null,"sharedCount":"0","responseDueDate":"2017-10-05T11:21:07.000Z","contact":{"firstName":"Jonathan","lastName":"Casie","phone":null,"mobile":null,"id":"1892000000045028","type":null,"email":"casie@zylker.com","account":{"website":"www.zylker.com","accountName":"Zylker Account","id":"1892000000980421"}},"createdTime":"2014-03-21T09:16:03.000Z","id":"1892000000137057","department":{"name":"dasdasdasd","id":"1892000000006907"},"email":"casie@zylker.com","channelCode":null,"customerResponseTime":"2014-03-21T10:54:21.802Z","productId":null,"contactId":"1892000000045028","threadCount":"19","team":{"name":"kjsdfjks","id":"8920000000069071"},"priority":"High","assigneeId":"1892000000042001","commentCount":"0","phone":null,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d11bcdfb061247d9edbacb9d93ba74750b0284bc703b38","teamId":"8920000000069071","isSpam":false,"assignee":{"firstName":"dasca","lastName":"vins","photoURL":"https://desk.zoho.com/api/v1/agents/1892000000042001/photo?orgId=298902","id":"1892000000042001","email":"jack@zylker.com"},"category":null,"status":"Custom On Hold"}]}