---
title: "List Group Roles"
method: GET
path: "/cloud/v2/groups/{group_id}/roles"
tags: ["Groups"]
---

# List Group Roles

`GET /cloud/v2/groups/{group_id}/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.

## Path parameters

- `group_id` string, required

## Query parameters

- `maxPageSize` integer
- `pageToken` string

## Response `200`

OK

- ListGroupRolesResponse — A list of GroupRoles in the parent collection.
  - `groupRoles` GroupRole[] — The GroupRoles from the specified Group.
    - `path` string — The resource path of the group role. Format: `groups/{group_id}/roles/{group_role_id}`
    - `createTime` string, date-time — The timestamp for when the group role was last updated. Visible only to owners of the group.
    - `updateTime` string, date-time — The timestamp when the group role was last updated. Visible only to owners of the group.
    - `id` string — A unique ID that identifies a role. Distinct from a role's rank, which is only unique within the group.
    - `displayName` string — The name of the role. Has a maximum limit of 100 characters. Names above the limit are rejected.
    - `description` string — The description of the role. Has a maximum limit of 1000 characters. Strings above the limit are rejected. Visible only to owners of the group.
    - `rank` integer — The rank of the role. The minimum value is 0. The maximum value is 255.
    - `memberCount` integer — Total number of members within a role. This field is not returned for guest roles.
    - `permissions` GroupRoleRolePermissions — Represents the permissions on a role.
      - `viewWallPosts` boolean — View group wall.
      - `createWallPosts` boolean — Post on group wall.
      - `deleteWallPosts` boolean — Delete group wall posts.
      - `viewGroupShout` boolean — View group shout.
      - `createGroupShout` boolean — Post group shout.
      - `changeRank` boolean — Manage lower-ranked member ranks.
      - `acceptRequests` boolean — Accept join requests.
      - `exileMembers` boolean — Kick lower-ranked members.
      - `manageRelationships` boolean — Manage allies and enemies.
      - `viewAuditLog` boolean — View audit log.
      - `spendGroupFunds` boolean — Spend group funds.
      - `advertiseGroup` boolean — Advertise group.
      - `createAvatarItems` boolean — Create avatar items.
      - `manageAvatarItems` boolean — Manage avatar items.
      - `manageGroupUniverses` boolean — Manage group universes.
      - `viewUniverseAnalytics` boolean — View universe analytics.
      - `createApiKeys` boolean — Create group API Keys.
      - `manageApiKeys` boolean — Manage all group API keys.
      - `banMembers` boolean — Ban lower-ranked members.
      - `viewForums` boolean — Can view forums
      - `manageCategories` boolean — Can change forum categories
      - `createPosts` boolean — Can create forum post
      - `lockPosts` boolean — Can lock forum post
      - `pinPosts` boolean — Can pin forum post
      - `removePosts` boolean — Can remove forum post
      - `createComments` boolean — Can create forum comment
      - `removeComments` boolean — Can remove forum comment
      - `manageBlockedWords` boolean — Can manage blocked words
      - `viewBlockedWords` boolean — Can view blocked words
      - `bypassSlowMode` boolean — can bypass slow mode
  - `nextPageToken` string — 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.

---

[API](https://skmtc.net/roblox/apis/roblox-api.md) · [All operations](https://skmtc.net/roblox/apis/roblox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/roblox/roblox-api/versions/e15802062270/schema)
