get-a-monitor.md

Get a Monitor

Get details of a specific monitor.

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/monitors/:username	yes

{% hint style="info" %} Permission required: manage-livechat-monitors {% endhint %}

Path Variables

Key	Example Value	Description
username*	1-agent	The username of the person monitoring.

Example Call

{% code overflow="wrap" %}

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

{% endcode %}

Example Response

{
    "_id": "RSb7exHJsiKqwRjPF",
    "username": "1-agent",
    "emails": [
        {
            "address": "1-agent@g.c",
            "verified": false
        }
    ],
    "status": "offline",
    "name": "1-agent",
    "statusLivechat": "not-available",
    "livechat": {
        "maxNumberSimultaneousChat": "4"
    },
    "success": true
}