External DocumentationTo learn more, visit the Zoho Desk documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| From | The index number starting from which the departments must be fetched. Starts at 0. |
| Is Enabled | Select to filter departments by their enabled status. |
| Limit | The maximum number of departments to get per page. Valid range is 1 to 200. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Search String | Search for departments by name, help center name, or description. Supported search patterns: string* (starts with), *string* (contains), or string (exact match). |
Advanced Parameters
| Parameter | Description |
|---|---|
| Chat Status | Filter departments by their chat status. |
Example Output
{
"data": [
{
"isAssignToTeamEnabled": true,
"chatStatus": "AVAILABLE",
"isDefault": true,
"hasLogo": true,
"isVisibleInCustomerPortal": true,
"isEnabled": true,
"name": "Zylker",
"creatorId": "1892000000042001",
"description": "Zylker Inc. is a multinational technology company that designs, develops, and sells consumer electronics.",
"createdTime": "2019-07-26T13:11:02.000Z",
"id": "1892000000082069",
"nameInCustomerPortal": "ZylCares"
},
{
"isAssignToTeamEnabled": true,
"chatStatus": "AVAILABLE",
"isDefault": false,
"hasLogo": true,
"isVisibleInCustomerPortal": true,
"isEnabled": true,
"name": "zPad",
"creatorId": "1892000000042001",
"description": "zPad is the most advanced tablet that brings you the never-experienced-before processing power.",
"createdTime": "2019-08-25T10:12:04.000Z",
"id": "1892000000082085",
"nameInCustomerPortal": "zPad"
}
]
}