Get Agent or Manager Information

Get
/api/v1/livechat/users/{type}/{_id}

Get information about a particular agent or a manager. Permission required: view-livechat-manager

Changelog

Version Description
0.42.0 Added
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
type
stringRequired

The type of user. The value can either be agent or manager.

_id
stringRequired

The user ID.

ExampleSQafHvoFPuB57NmBD
Responses
200

OK

Success Example
{
  "user": {
    "_id": "SQafHvoFPuB57NmBD",
    "username": "john.doe",
    "name": "John Doe",
    "status": "offline",
    "statusLivechat": "available",
    "emails": [
      {
        "address": "[email protected]",
        "verified": true
      }
    ],
    "livechat": {
      "maxNumberSimultaneousChat": ""
    }
  },
  "success": true
}
Expand All
object
user
object
_id
string
username
string
name
string
status
string
statusLivechat
string
emails
Array of object
object
address
string
verified
string
livechat
object
maxNumberSimultaneousChat
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