Get Department Information

Get information about a specific department using the department ID.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/department/:_id
​yes​
Permission required: view-l-room
Path Variables
Key
Example Value
Description
_id*
SQafHvoFPuB57NmBD
The department _id.
Query Parameters
Key
Example Value
Description
includeAgents
true
If agents should be included in the result. This parameter is optional. By default, the value is true and the list of agents is returned.
The agents field will only be returned if the user has the view-livechat-departments permission.
Example Call
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/livechat/department/iTfLCX3qqwKgf5uqg
Example Response
{
  "department": {
    "_id": "iTfLCX3qqwKgf5uqg",
    "enabled": false,
    "name": "new from api",
    "description": null,
    "numAgents": 1,
    "showOnRegistration": true,
    "_updatedAt": "2016-12-13T17:22:19.109Z"
  },
  "agents": [
    {
      "_id": "DDjZbhTF74n3NBuWK",
      "agentId": "SQafHvoFPuB57NmBD",
      "departmentId": "iTfLCX3qqwKgf5uqg",
      "username": "john.doe",
      "count": 0,
      "order": 0,
      "_updatedAt": "2016-12-13T17:22:19.169Z"
    }
  ],
  "success": true
}
Change Log
Version
Description
2.2.0
Added includeAgents query parameter
0.42.0
Added

HTTP Method	URL	Requires Auth
`GET`	`/api/v1/livechat/department/:_id`	`yes`

Key	Example Value	Description
`_id*`	`SQafHvoFPuB57NmBD`	The department `_id`.

Key	Example Value	Description
`includeAgents`	`true`	If agents should be included in the result. This parameter is optional. By default, the value is `true` and the list of agents is returned.

Version	Description
2.2.0	Added `includeAgents` query parameter
0.42.0	Added

Last modified 6d ago