List tickets by status
GET {{baseUrl}}/api/v1/ticketsByStatus?status=<string> max chars : 100
This API fetches tickets by resolution status which is mapped to either OPEN or ON HOLD
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 | |
status | string | Status of the ticket. Includes the custom statuses configured in your help desk | |
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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"ticketNumber":"101","subCategory":null,"statusType":"On Hold","subject":"Real Time analysis Requirement","dueDate":null,"departmentId":"1892000000006907","channel":"Email","isRead":false,"onholdTime":"2016-06-21T16:16:16.000Z","language":"English","closedTime":null,"sharedCount":"0","contact":{"lastName":"Lawrence","firstName":"Jonathan","phone":"1 888 900 9646","mobile":"8834562344","id":"1892000000042032","type":null,"email":"lawrence@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":"lawrence@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/d126330fb061247ca87daeb9d93ba74750b0284bc703b38","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":"On Hold"},{"ticketNumber":"169","subCategory":null,"statusType":"On Hold","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,"onholdTime":"2014-03-06T11:34:53.000Z","closedTime":null,"sharedCount":"0","contact":{"lastName":"Lawrence","firstName":"Jonathan","phone":"1 888 900 9646","mobile":"8832345108","id":"1892000000042032","type":null,"email":"lawrence@zylker.com","account":{"website":null,"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/d126330fb061247d9eb9bb9d93ba74750b0284bc703b38","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":"On Hold"}]}