Get Channel Roles

HTTP MethodURLRequires Auth

GET

/api/v1/channels.roles

Query Parameters

KeyExample ValueDescription

roomId* or roomName*

ByehQjC44FwMeiLbX

The channel ID or name. You must enter at least one of the parameters.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     https://localhost:3000/api/v1/channels.roles?roomId=ByehQjC44FwMeiLbX

Example Response

{
    "roles": [
        {
            "rid": "BaE62jfDLXK3Xo6BA",
            "u": {
               "_id": "BkNkw3iKgNyhMbPyW",
               "username": "ronnie.dio",
               "name": "Ronnie James Dio"
            },
            "roles": [
               "moderator"
            ],
            "_id": "ehPuGyZBedznJsQHp"
        }
    ],
    "success": true
}

Change Log

VersionDescription

0.65.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.