Get Channel Roles

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/channels.roles

Lists all user's roles in the channel.

Changelog

Version	Description
0.65.0	Added

Query parameters

roomId

string

The room id. It is required if the roomName is not provided.

Exampledlpfuijw7ej

roomName

string

The room name. It is required if the roomId is not provided.

Examplegeneral

Responses

200

Example 1

{
  "roles": [
    {
      "_id": "rGNoXwYuZshq9FENQ",
      "rid": "WDuJLFkjwk6L7LdFC",
      "u": {
        "_id": "rbAXPnMktTFbNpwtJ",
        "username": "roxie"
      },
      "roles": [
        "owner"
      ]
    },
    {
      "_id": "64ef8a982c26843a68c1f7ae",
      "rid": "WDuJLFkjwk6L7LdFC",
      "u": {
        "_id": "5fRTXMt7DMJbpPJfh",
        "username": "test.test",
        "name": "Testtest"
      },
      "roles": [
        "leader"
      ]
    }
  ],
  "success": true
}

Expand All

object

roles

Array of object

object

_id

string

rid

string

object

_id

string

username

string

name

string

roles

Array of string

string

success

boolean

Was this article helpful?

What's Next

Set Channel Announcement