Get List of Agents or Managers

Prev Next
Get
/api/v1/livechat/users/{type}
  • If the type is manager, permission required: view-livechat-manager.
  • If the type is agent, permission required: at least one of transfer-livechat-guest or edit-omnichannel-contact.

Changelog

Version Description
2.2.0 Added support to pagination
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 that you want to register. The value can either be agent or manager.

Exampleagent
Query parameters
offset
integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
count
integer

The number of items to return. Refer to the official documentation to learn more.

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}. Refer to the official documentation to learn more.

onlyAvailable
boolean

When set to true, it only list agents whose livechat status (statusLivechat) is available.

Exampletrue
showIdleAgents
boolean

When set to false, offline agents will be excluded from the response. This filter does not apply to bots. All bot agents will be returned in the response.

Examplefalse
excludeId
string

The ID of a specific agent to exclude from the list.

ExampleAhgfwk9sasYEsMjwX
text
string

Enter the text you want to filter the search result with.

Exampletrue
Responses
200

OK

Success Example
{
  "users": [
    {
      "_id": "XLzGrYF9L2miSpPHP",
      "username": "dialog.bot",
      "status": "offline",
      "statusLivechat": "not-available",
      "name": "Dialog Bot",
      "emails": [
        {
          "address": "dialog.bot@test.com",
          "verified": true
        }
      ],
      "livechat": null,
      "departments": []
    },
    {
      "_id": "rbAXPnMktTFbNpwtJ",
      "username": "john.doe",
      "status": "offline",
      "statusLivechat": "available",
      "name": "John Doe",
      "emails": [
        {
          "address": "john.doe@gmail.com",
          "verified": true
        }
      ],
      "livechat": {
        "maxNumberSimultaneousChat": ""
      },
      "departments": [
        "64181a0728384134ed600dcc"
      ]
    },
    {
      "_id": "hFDuCPam7sWziWFYa",
      "username": "hookdeck.write",
      "status": "offline",
      "statusLivechat": "not-available",
      "name": "Hookdeck Write",
      "emails": [
        {
          "address": "hookdeckwrite@gmail.com",
          "verified": true
        }
      ],
      "livechat": null,
      "departments": []
    },
    {
      "_id": "stjxrXYBWy3EcDugH",
      "username": "rocket.agent",
      "status": "offline",
      "statusLivechat": "not-available",
      "name": "Rocket Agent",
      "emails": [
        {
          "address": "rocket.agent@rocket.chat",
          "verified": false
        }
      ],
      "livechat": {
        "maxNumberSimultaneousChat": ""
      },
      "departments": [
        "64181a0728384134ed600dcc"
      ]
    }
  ]
}
Expand All
object
users
Array of object
object
_id
string
username
string
status
string
statusLivechat
string
name
string
emails
Array of object
object
address
string
verified
boolean
livechat
string
departments
Array of string
string
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