Get List of Monitors
- Print
- DarkLight
- PDF
Get List of Monitors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/livechat/monitors
Retrieves a list of monitors. Permission required: manage-livechat-monitors
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
count
integer
The number of items to return.
Example25
sort
(object)
List of fields to order by, and in which direction. JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, sort = {"value": -1, "_id": 1}
text
string
Filter the result with the text.
Responses
200
OK
Success Example
{
"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
}object
monitors
Array of object
object
_id
string
username
string
emails
Array of object
object
address
string
verified
boolean
status
string
name
string
statusLivechat
string
count
integer
offset
integer
total
integer
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?