Sign in

v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB
Groups

List Group Roles

List roles in a group.

The permissions field for roles is viewable based on the requester's access and scopes.

Permissions for the guest role are always visible - a scope is not needed.

If the requester is a member of the group and has the group:read scope, permissions in their role are visible.

If the requester is the owner of the group and has the group:read scope, permissions in all roles are visible.

get/cloud/v2/groups/{group_id}/roles

Path parameters

group_idstring required

The group ID.

Query parameters

maxPageSizeinteger

The maximum number of group roles to return. The service might return fewer than this value. If unspecified, at most 10 group roles are returned. The maximum value is 20 and higher values are set to 20.

pageTokenstring

A page token, received from a previous call, to retrieve a subsequent page.

When paginating, all other parameters provided to the subsequent call must match the call that provided the page token.

Response

OK

nextPageTokenstring

A token that you can send as a pageToken parameter to retrieve the next page. If this field is omitted, there are no subsequent pages.

Example response

{
  "groupRoles": [
    {
      "path": "groups/123/roles/123",
      "createTime": "2023-07-05T12:34:56Z",
      "updateTime": "2023-07-05T12:34:56Z",
      "id": "200",
      "displayName": "Member",
      "description": "This is a description for the role",
      "rank": 1,
      "memberCount": 10223136,
      "permissions": {
        "viewWallPosts": true,
        "createWallPosts": true,
        "deleteWallPosts": true,
        "viewGroupShout": true,
        "createGroupShout": true,
        "changeRank": true,
        "acceptRequests": true,
        "exileMembers": true,
        "manageRelationships": true,
        "viewAuditLog": true,
        "spendGroupFunds": true,
        "advertiseGroup": true,
        "createAvatarItems": true,
        "manageAvatarItems": true,
        "manageGroupUniverses": true,
        "viewUniverseAnalytics": true,
        "createApiKeys": true,
        "manageApiKeys": true,
        "banMembers": true,
        "viewForums": true,
        "manageCategories": true,
        "createPosts": true,
        "lockPosts": true,
        "pinPosts": true,
        "removePosts": true,
        "createComments": true,
        "removeComments": true,
        "manageBlockedWords": true,
        "viewBlockedWords": true,
        "bypassSlowMode": true
      }
    }
  ]
}