Links

Get List of Agents or Managers

Get a list of agents or managers.
HTTP Method
URL
Requires Auth
GET
/api/v1/livechat/users/:type
yes

Path Variables

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

Query Parameters

The Pagination query parameters are supported and optional.

Example Call

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

Example Response

{
"users": [
{
"_id": "XLzGrYF9L2miSpPHP",
"username": "dialog.bot",
"status": "offline",
"statusLivechat": "not-available",
"name": "Dialog Bot",
"emails": [
{
"address": "[email protected]",
"verified": true
}
],
"livechat": null,
"departments": []
},
{
"_id": "rbAXPnMktTFbNpwtJ",
"username": "john.doe",
"status": "offline",
"statusLivechat": "available",
"name": "John Doe",
"emails": [
{
"address": "[email protected]",
"verified": true
}
],
"livechat": {
"maxNumberSimultaneousChat": ""
},
"departments": [
"64181a0728384134ed600dcc"
]
},
{
"_id": "hFDuCPam7sWziWFYa",
"username": "hookdeck.write",
"status": "offline",
"statusLivechat": "not-available",
"name": "Hookdeck Write",
"emails": [
{
"address": "[email protected]",
"verified": true
}
],
"livechat": null,
"departments": []
},
{
"_id": "stjxrXYBWy3EcDugH",
"username": "rocket.agent",
"status": "offline",
"statusLivechat": "not-available",
"name": "Rocket Agent",
"emails": [
{
"address": "[email protected]",
"verified": false
}
],
"livechat": {
"maxNumberSimultaneousChat": ""
},
"departments": [
"64181a0728384134ed600dcc"
]
}

Change Log

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