Get a Unit

Get details of a specific unit.

HTTP MethodURLRequires Auth

GET

/api/v1/livechat/units/:unitId

Permission required: manage-livechat-units

Path Variables

KeyExample ValueDescription

unitId*

sriw2wmP2Zz2pPrre

The 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'

Example Response

{
    "_id": "LnM2rzbknjYSkkd5p",
    "name": "Sales Unit",
    "visibility": "public",
    "type": "u",
    "numMonitors": 1,
    "numDepartments": 2,
    "_updatedAt": "2022-09-15T11:44:15.721Z",
    "success": true
}

Last updated

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