Links

List of Monitors

Retrieves a list of monitors
This endpoint has been renamed to Get Monitors as from Rocket.Chat 5.0
URL
Requires Auth
HTTP Method
api/v1/livechat/monitors.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

{
"monitors": [
{
"_id": "gxcJTYapi5mPxuAme",
"username": "Bruno",
"emails": [
{
"address": "",
"verified": false
}
],
"status": "offline",
"name": "Bruno",
"statusLivechat": "not-available"
},
{
"_id": "QDHWqcubZunM8C4NR",
"username": "gomes",
"emails": [
{
"address": "",
"verified": true
}
],
"status": "offline",
"name": " Gomes",
"statusLivechat": "not-available"
},
],
"count": 2,
"offset": 0,
"total": 2,
"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.