External DocumentationTo learn more, visit the Zoho Desk documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Assignee IDs | A comma-separated list of assignee IDs to filter tickets by. Use Unassigned for tickets not assigned to any agent. |
| Department IDs | A comma-separated list of department IDs to filter tickets by. Can be obtained from the List Departments action. |
| From | The index number starting from which the tickets must be fetched. Starts at 1. |
| Include | Select additional related data to include in the response. |
| Limit | The maximum number of tickets to get per page. Valid range is 1 to 100. |
| Priority | A comma-separated list of ticket priorities to filter results by. System-defined values include Low, Medium, and High. Custom values are also supported. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Sort By | Select the attribute to sort the tickets by. |
| Status | A comma-separated list of ticket statuses to filter results by. |
| Team IDs | A comma-separated list of team IDs to filter tickets by. Use Unassigned for tickets not assigned to any team. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Channel | A comma-separated list of channels to filter tickets by. |
| Fields | A comma-separated list of system and custom fields to include in the response. A maximum of 30 fields is allowed. |
| Received In Days | The time period in days for fetching tickets based on customer response time. |
| View ID | The ID of the custom view to filter tickets by. |
Example Output
{
"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",
"logoUrl": "https://desk.zoho.com/api/v1/teams/8920000000069071/logo?orgId=11278831"
},
"priority": "High",
"assigneeId": "1892000000056007",
"commentCount": "1",
"accountId": "189200000005345",
"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",
"logoUrl": "https://desk.zoho.com/api/v1/teams/8920000000069071/logo?orgId=11278831"
},
"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",
"logoUrl": "https://desk.zoho.com/api/v1/teams/8920000000069071/logo?orgId=11278831"
},
"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"
}
]
}
Workflow Library Example
List Tickets with Zoho Desk and Send Results Via Email