Get List of Departments

Get a list of the departments.

Query Parameters

Example Call

curl --location 'http://localhost:3000/api/v1/livechat/department' \
--header 'X-Auth-Token: Y97tM4GkYjgaH_fIO5dwBitQ' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC' \
--data ''

Example Response

{
    "departments": [
        {
            "_id": "64181a0728384134ed600dcc",
            "enabled": true,
            "name": "Support",
            "description": "",
            "showOnRegistration": false,
            "showOnOfflineForm": false,
            "requestTagBeforeClosingChat": false,
            "email": "kim.jane@rocketchat.com",
            "chatClosingTags": [],
            "offlineMessageChannelName": "Livestream",
            "abandonedRoomsCloseCustomMessage": "",
            "waitingQueueMessage": "",
            "departmentsAllowedToForward": [],
            "fallbackForwardDepartment": "",
            "_updatedAt": "2023-10-13T13:03:58.406Z",
            "numAgents": 4,
            "type": "d"
        },
        {
            "_id": "649230d479f5c6e276cf4a12",
            "enabled": false,
            "name": "Finance",
            "description": "",
            "showOnRegistration": false,
            "showOnOfflineForm": false,
            "requestTagBeforeClosingChat": false,
            "email": "test@gmail.com",
            "chatClosingTags": [],
            "offlineMessageChannelName": "",
            "abandonedRoomsCloseCustomMessage": "",
            "waitingQueueMessage": "",
            "departmentsAllowedToForward": [],
            "fallbackForwardDepartment": "",
            "type": "d",
            "_updatedAt": "2023-10-13T13:03:58.426Z",
            "numAgents": 3,
            "businessHourId": "650dc9cfa2f73c7460e18bea"
        }
    ],
    "count": 2,
    "offset": 0,
    "total": 2,
    "success": true
}

Change Log

Last updated

Rocket.Chat versions receive support for six months after release.