Get one Unit

Gives the details of a unit

URLRequires AuthHTTP Method

api/v1/livechat/units.getOne

YES

GET

Headers

ArgumentExampleRequiredDescription

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)

Parameters

ArgumentExampleRequiredDescription

unitId

sriw2wmP2Zz2pPrre

Required

Unit ID

Example Call

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

Result

{
    "_id": "sriw2wmP2Zz2pPrre",
    "name": "Support",
    "visibility": "public",
    "type": "u",
    "numMonitors": 3,
    "numDepartments": 4,
    "_updatedAt": "2021-06-28T22:10:01.295Z",
    "success": true
}

Last updated

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