GroupRole

Attributes

pathstring
createTimestring
Output Only
updateTimestring
Output Only
idstring
Output Only
displayNamestring
descriptionstring
ranknumber
memberCountnumber
Output Only
permissionsobject
Base URL
https://apis.roblox.com
The GroupRole Resource
{

  "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

  }

}

GroupRole

List Group Roles
Beta

GET /cloud/v2/groups/{group_id}/roles
RequestPath Parameters
group_idstring
Required
Query Parameters
maxPageSizenumber
pageTokenstring
Response
nextPageTokenstring
GET /cloud/v2/groups/{group_id}/roles
curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group_id}/roles?maxPageSize=10&pageToken={string}' \

  -H 'x-api-key: {your-api-key}'
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

      }

    }

  ],

  "nextPageToken": "string"

}

GroupRole

Get Group Role
Beta

GET /cloud/v2/groups/{group_id}/roles/{role_id}
RequestPath Parameters
group_idstring
Required
role_idstring
Required
ResponseGroupRole
GET /cloud/v2/groups/{group_id}/roles/{role_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group_id}/roles/{role_id}' \

  -H 'x-api-key: {your-api-key}'
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

  }

}