List tickets by tag
GET {{baseUrl}}/v1/tags/:tag_id/tickets
This API lists tickets containing the tag specified.
OAuth Scope
Desk.tickets.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
from | string | Index number, starting from which tickets must be fetched. | |
limit | string | Number of tickets to list | |
assignee | string | User assigned to resolve the ticket. Values allowed are Unassigned or a valid assigneeId . You can pass multiple assigneeIds as comma-separated values. | |
channel | string | Channel through which the tickets were received. You can pass multiple values by separating them with commas. | |
status | string | Resolution status of the tickets. You can pass multiple values by separating them with commas. | |
receivedInDays | string | Number of days since the tickets were received. Values allowed are 15 , 30 , 90 . | |
priority | string | Priority of the tickets. You can pass multiple values by separating them with commas. | |
sortBy | string | Key that sorts the tickets by a specific attribute: dueDate , recentThread , createdTime , or ticketNumber . The default sorting order is ascending. A - prefix denotes a descending order of sorting. | |
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. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"ticketNumber":"101","statusType":"Open","subject":"Real Time analysis Requirement","dueDate":"2016-06-21T16:16:16.000Z","departmentId":"1892000000006907","channel":"Email","isRead":true,"language":"English","closedTime":null,"contact":{"lastName":"Carol","firstName":"Lucas","phone":"1 888 900 9646","mobile":"8838109870","id":"1892000000042032","isSpam":false,"type":"paid","email":"carol@zylker.com","account":{"website":"www.desk.com","accountName":"desk Account","id":"1892000000975382"}},"createdTime":"2013-11-04T11:21:07.000Z","id":"1892000000042034","department":{"name":"dasdasdasd","id":"1892000000006907"},"email":"carol@zylker.com","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,"status":"Open"},{"ticketNumber":"169","statusType":"Open","subject":"Hi. There is a sudden delay in the processing of the orders. Check this with high priority","dueDate":null,"departmentId":"1892000000006907","channel":"Facebook","isRead":true,"closedTime":null,"contact":{"lastName":"Richard","firstName":"Lucas","phone":"1 888 900 9646","mobile":"8838109870","id":"1892000000093203","isSpam":false,"type":"paid","email":"richard@zylker.com","account":{"website":"www.desk.com","accountName":"desk Account","id":"1892000000975382"}},"createdTime":"2014-03-06T09:34:53.000Z","id":"1892000000093205","department":{"name":"dasdasdasd","id":"1892000000006907"},"email":"carol@zylker.com","customerResponseTime":"2014-03-11T07:51:29.618Z","productId":null,"contactId":"1892000000093203","threadCount":"43","team":{"name":"kjsdfjks","id":"8920000000069071"},"priority":null,"assigneeId":"1892000000042001","commentCount":"0","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/1892000000042001/photo?orgId=298902","id":"1892000000042001","email":"jack@zylker.com"},"isSpam":false,"status":"Open"}]}