Get Departments by ID

Get a list of departments by department IDs.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/department.listByIds
​yes​
Permissions required:
view-livechat-departments
view-l-room
Query Parameters
Key
Example Value
Description
ids*
4LCeYmCHHnQ3EDBgf
The department ID.
ids*
CAJioQNAvLnYWTy8i
The department ID.
ids
mHcx4rbi7htAmCCR5
The department ID.
Example Call
curl --location --request GET 'http://localhost:3000/api/v1/livechat/department.listByIds?
    ids=4LCeYmCHHnQ3EDBgf
    &ids=CAJioQNAvLnYWTy8i
    &ids=mHcx4rbi7htAmCCR5\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
Example Response
{
    "departments": [
        {
            "_id": "4LCeYmCHHnQ3EDBgf",
            "enabled": true,
            "name": "Chatbot Sales",
            "description": "",
            "showOnRegistration": false,
            "showOnOfflineForm": false,
            "requestTagBeforeClosingChat": false,
            "email": "[email protected]",
            "chatClosingTags": [],
            "offlineMessageChannelName": "",
            "abandonedRoomsCloseCustomMessage": "",
            "waitingQueueMessage": "",
            "departmentsAllowedToForward": "",
            "_updatedAt": "2021-07-15T15:11:16.856Z",
            "numAgents": 4,
            "ancestors": []
        },
        {
            "_id": "CAJioQNAvLnYWTy8i",
            "enabled": true,
            "name": "Support",
            "description": "",
            "showOnRegistration": true,
            "showOnOfflineForm": true,
            "requestTagBeforeClosingChat": false,
            "email": "[email protected]",
            "maxNumberSimultaneousChat": "",
            "waitingQueueMessage": "",
            "type": "d",
            "numAgents": 28,
            "_updatedAt": "2021-07-21T23:54:35.574Z",
            "ancestors": [
                "sriw2wmP2Zz2pPrre"
            ],
            "chatClosingTags": [],
            "abandonedRoomsCloseCustomMessage": "",
            "departmentsAllowedToForward": "",
            "offlineMessageChannelName": "",
            "visitorInactivityTimeoutInSeconds": "10",
            "parentId": "sriw2wmP2Zz2pPrre"
        },
        {
            "_id": "mHcx4rbi7htAmCCR5",
            "enabled": true,
            "name": "Chatbot Support",
            "description": "",
            "showOnRegistration": false,
            "showOnOfflineForm": false,
            "requestTagBeforeClosingChat": false,
            "email": "[email protected]",
            "chatClosingTags": [],
            "offlineMessageChannelName": "",
            "abandonedRoomsCloseCustomMessage": "",
            "waitingQueueMessage": "",
            "departmentsAllowedToForward": "",
            "_updatedAt": "2021-06-28T22:10:01.371Z",
            "numAgents": 3,
            "ancestors": [
                "sriw2wmP2Zz2pPrre"
            ],
            "parentId": "sriw2wmP2Zz2pPrre"
        }
    ],
    "success": true
}

HTTP Method	URL	Requires Auth
`GET`	`/api/v1/livechat/department.listByIds`	`yes`

Key	Example Value	Description
`ids*`	`4LCeYmCHHnQ3EDBgf`	The department ID.
`ids*`	`CAJioQNAvLnYWTy8i`	The department ID.
`ids`	`mHcx4rbi7htAmCCR5`	The department ID.

Last modified 6d ago