Cloud

GroupRole

Attributes

pathstring

createTimestring

updateTimestring

idstring

displayNamestring

descriptionstring

ranknumber

memberCountnumber

permissionsobject

Base URL

https://apis.roblox.com/cloud
The GroupRole Resource

{
"path": "groups/7/roles/200",
"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
}
}

List Group Roles

GET /v2/groups/{group}/roles
RequestPath Parameters
groupstringRequired

Query Parameters
maxPageSizenumber

pageTokenstring

Response
groupRolesarray<GroupRole>

nextPageTokenstring

GET /v2/groups/{group}/roles

curl --include --location -X GET "https://apis.roblox.com/cloud/v2/groups/{group}/roles?maxPageSize=10&pageToken=<string>" \
--header "x-api-key: <api-key>"
Response

{
"groupRoles": [
{
"path": "groups/7/roles/200",
"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
}
}
],
"nextPageToken": "string"
}