List of Unit

Gives a list of units

​ This endpoint has been renamed to Get Units as from Rocket.Chat 5.0
URL
Requires Auth
HTTP Method
api/v1/livechat/units.list
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)
Example Call
curl --location --request GET 'http://localhost:3000/api/v1/livechat/units.list\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
Result
{
    "units": [
        {
            "_id": "sriw2wmP2Zz2pPrre",
            "name": "Support",
            "visibility": "public",
            "type": "u",
            "numMonitors": 3,
            "numDepartments": 4,
            "_updatedAt": "2021-06-28T22:10:01.295Z"
        }
    ],
    "count": 1,
    "offset": 0,
    "total": 1,
    "success": true
}

URL	Requires Auth	HTTP Method
`api/v1/livechat/units.list`	`YES`	`GET`

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)

Last modified 2mo ago