roles.md

Get Group Roles

Lists all user's roles in the group/channel.

HTTP Method	URL	Requires Auth
GET	/api/v1/groups.roles	yes

Query Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The group ID. The parameter is required if roomName is not provided.
roomName*	general	The group name. The parameter is required if the roomId is not provided.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/groups.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

Version	Description
0.65.0	Added