List departments
GET {{baseUrl}}/api/v1/departments
This API lists a particular number of departments, based on the limit specified.
OAuth Scope
Desk.settings.READDesk.basic.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
isEnabled | string | Key that filters departments based on their enabled status | |
from | string | Index number, starting from which the departments must be fetched | |
searchStr | string | String to search for departments by name, help center name, or description. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for departments whose name, help center name, or description start with the string, 2) string - Searches for departments whose name, help center name, or description contain the string, 3) string - Searches for departments whose name, help center name, or description is an exact match for the string | |
limit | string | Number of departments to fetch; default value is 10 and maximum value supported is 200 | |
chatStatus | string | Key that filters departments based on their chat status. Values allowed are AVAILABLE, DISABLED, NOT_CREATED, and ${UNAVAILABLE}. ${UNAVAILABLE} refers to departments which are not available for chat. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"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"}]}