Links

Get a Unit

Get details of a unit.
This requires the manage-livechat-units permission
URL
Requires Auth
HTTP Method
api/v1/livechat/units/:unitId
YES
GET

Headers

Argument
Example
Required
Description
X-User-Id
myuser-name
Required
Your username hash (returned after you log in through the API)
X-Auth-Token
myauth-token
Required
Your token (returned after you log in through the API)

Path Parameter

Argument
Example
Required
Description
unitId
sriw2wmP2Zz2pPrre
Required
Unit ID

Example Call

curl --location --request GET 'http://localhost:3000/api/v1/livechat/units/sriw2wmP2Zz2pPrre \
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

Result

{
"_id": "LnM2rzbknjYSkkd5p",
"name": "Sales Unit",
"visibility": "public",
"type": "u",
"numMonitors": 1,
"numDepartments": 2,
"_updatedAt": "2022-09-15T11:44:15.721Z",
"success": true
}
Last modified 2mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.