Links

Get Agent or Manager Information

Get information about a particular agent or a manager.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/users/:type/:_id
yes

Path Variables

Key
Example Value
Description
type *
agent
The type of user. The value can either be agent or manager.
_id *
SQafHvoFPuB57NmBD
The user _id.

Example Call

curl --location 'http://localhost:3000/api/v1/livechat/users/agent/PSaBmpB2c9eFaE79q' \
--header 'X-Auth-Token: Y97tM4GkYjgaH_fIO5dwBitQQvm3yp-AptYzGQZMX6e' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC' \
--data ''

Example Response

{
"user": {
"_id": "SQafHvoFPuB57NmBD",
"username": "john.doe",
"name": "John Doe",
"status": "offline",
"statusLivechat": "available",
"emails": [
{
"address": "[email protected]",
"verified": "true"
}
],
"livechat": {
"maxNumberSimultaneousChat": ""
}
},
"success": true
}

Change Log

Version
Description
0.42.0
Added
Last modified 25d ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.