ROroblox
Groups

Get Group Role

Get the group role

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

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/groups/{group_id}/roles/{role_id}
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token

Path parameters

group_idstring required

The group ID.

role_idstring required

The role ID.

Response

OK

pathstring

The resource path of the group role.

Format: groups/{group_id}/roles/{group_role_id}

createTimestring date-time

The timestamp for when the group role was last updated.

Visible only to owners of the group.

updateTimestring date-time

The timestamp when the group role was last updated.

Visible only to owners of the group.

idstring

A unique ID that identifies a role.

Distinct from a role's rank, which is only unique within the group.

displayNamestring

The name of the role.

Has a maximum limit of 100 characters. Names above the limit are rejected.

descriptionstring

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.

rankinteger

The rank of the role.

The minimum value is 0. The maximum value is 255.

memberCountinteger

Total number of members within a role.

This field is not returned for guest roles.

Example response

{
  "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
  }
}

Changes

No recorded changes to this operation across all 33 revisions of this API.