List all associated tickets
GET {{baseUrl}}/api/v1/associatedTickets
This API lists a particular number of tickets that are associated to you from your help desk, 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 listed | |
limit | string | Number of tickets to fetch | |
departmentId | string | ID of the department from which the tickets must be fetched | |
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. | |
status | string | Filter by resolution status of the ticket. You can include multiple values by separating them with a comma | |
follower | string | Filter by followers of the ticket. Values allowed : a valid agentId. | |
commenter | string | Filter by commenters of the ticket. Values allowed : a valid agentId. As of now, either follower or commenter is supported. If both params are given, commenter will be ignored. | |
sharedDepartmentId | string | Fetches only the tickets shared from departmentId to sharedDepartmentId. If departmentId is not provided, fetches all the tickets shared to sharedDepartmentId. sharedDepartmentId is given precedence only when isShared is false/not given. | |
isShared | string | Filter all shared tickets actually belonging to departmentId if isShared is true. If departmentId is not provided and if isShared is true, shared tickets from all permitted departments will be listed. If departmentId is provided and isShared is true, tickets belonging to departmentId, but shared to any other department will be fetched. If departmentId and sharedDepartmentId is provided and isShared is true, then tickets belonging to departmentId, but shared to sharedDepartmentId will be fetched(Here permission checks are done on departmentId). If departmentId and sharedDepartmentId is provided and isShared is false/not given, then tickets shared to sharedDepartmentId, but belonging to departmentId will be fetched(Here permission checks are done on sharedDepartmentId). | |
receivedInDays | string | Fetches recent tickets, based on customer response time. Values allowed are 15, 30 , 90. | |
include | string | Key that returns additional information related to a ticket. Values allowed are: contacts, products, and assignee. All three values can be passed by separating them with a comma in the API request. |
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","onholdTime":null,"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":"9876543212","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","email":"carol@zylker.com","channelCode":null,"customerResponseTime":"2013-11-04T11:21:07.912Z","productId":null,"contactId":"1892000000042032","threadCount":"121","priority":"High","assigneeId":"1892000000056007","commentCount":"1","phone":null,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38","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":"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","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":null,"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","email":"casie@zylker.com","channelCode":null,"customerResponseTime":"2014-03-22T05:05:08.471Z","productId":null,"contactId":"1892000000045028","threadCount":"72","priority":"High","assigneeId":"1892000000056007","commentCount":"0","phone":null,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d126330fb061247d9ebddaeb9d93ba74750b02214oc203b38","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":"Open","subject":"Real Time analysis Requirement","dueDate":null,"departmentId":"1892000000006907","channel":"Chat","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":"9876543212","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","email":"casie@zylker.com","channelCode":null,"customerResponseTime":"2014-03-21T10:54:21.802Z","productId":null,"contactId":"1892000000045028","threadCount":"19","priority":"High","assigneeId":"1892000000042001","commentCount":"0","phone":null,"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/d11bcdfb061247d9edbacb9d93ba74750b0284bc703b38","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":"Open"}]}