Links

Get List of Monitors

Retrieves a list of monitors.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/monitors
yes
Permission required: manage-livechat-monitors

Query Parameters

This endpoint supports the optional Paginationquery parameters.

Example Call

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

Example Response

{
"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
Rocket.Chat versions receive support for six months after release.