Get List of Unit Monitors

Get the list of monitors associated with a specific unit.

HTTP MethodURLRequires Auth

GET

/api/v1/livechat/units/:unitId/monitors

Permission required: manage-livechat-monitors

Path Variables

KeyExample ValueDescription

unitId*

sriw2wmP2Zz2pPrre

The unit ID.

Example Call

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

Example Response

{
    "monitors": [
        {
            "_id": "Gv8rxcv4WTEDnnGiT",
            "monitorId": "MJk4XK5QpsFWJzmSz",
            "unitId": "TGjc7wN84KxQup9cF",
            "_updatedAt": "2022-11-21T11:16:01.708Z",
            "username": "jjay"
        },
        {
            "_id": "dvSh7G6WW6J5XykQw",
            "monitorId": "GdyoCfHfd3um5N9vP",
            "unitId": "TGjc7wN84KxQup9cF",
            "_updatedAt": "2022-11-21T11:16:01.718Z",
            "username": "j.coel"
        }
    ],
    "success": true
}

Last updated

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