Get List of Unit Monitors

Prev Next
Get
/api/v1/livechat/units/{unitId}/monitors
Premium tag

Get the list of monitors associated with a specific unit.
Permission required: manage-livechat-units

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Path parameters
unitId
stringRequired

The unit ID.

Responses
200
Success Example
{
  "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
}
Expand All
object
monitors
Array of object
object
_id
string
monitorId
string
unitId
string
_updatedAt
string
username
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string
Tags