Get Users in Public Roles

Prev Next
Get
/api/v1/roles.getUsersInPublicRoles

Use this endpoint to get the list of roles other than user, such as admin, livechat, and custom roles.

Changelog

Version Description
7.10.0 Added
Header parameters
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
Responses
200

OK

Example 1
{
  "users": [
    {
      "_id": "kb2WBkjkut4YJpFQk",
      "username": "agent2",
      "roles": [
        "livechat-agent"
      ]
    },
    {
      "_id": "Ahgf5k9Ca4YEdMjwX",
      "username": "test.agent",
      "roles": [
        "admin",
        "livechat-agent"
      ]
    }
  ],
  "success": true
}
Expand All
object
users
Array of object
object
_id
string
username
string
roles
Array of string
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string