List Group Roles

Prev Next
Get
/api/v1/groups.roles

List all the roles of users in the private channel.

Changelog

Version Description
0.65.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
Query parameters
roomId
stringRequired

Enter the private channel ID. Alternatively, you can use the roomName parameter and enter the private channel's name.

Example67ade8ef57422a89b02e2ce3
Responses
200

OK

Example
{
  "roles": [
    {
      "rid": "BaE62jfDLXK3Xo6BA",
      "u": {
        "_id": "BkNkw3iKgNyhMbPyW",
        "username": "ronnie.dio",
        "name": "Ronnie James Dio"
      },
      "roles": [
        "moderator"
      ],
      "_id": "ehPuGyZBedznJsQHp"
    }
  ],
  "success": true
}
Expand All
object
roles
Array of object
object
rid
string
u
object
_id
string
username
string
name
string
roles
Array of string
string
_id
string
success
boolean
401

Unauthorized

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