GroupMembership

Attributes

pathstring
createTimestring
Output Only
updateTimestring
Output Only
userstring
Immutable
rolestring
Base URL

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

{
"path": "groups/123/memberships/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/21557",
"role": "groups/7/roles/52"
}

GroupMembership

List Group Memberships
Beta

GET /cloud/v2/groups/{group}/memberships
RequestPath Parameters
groupstring
Required
Query Parameters
maxPageSizenumber
pageTokenstring
filterstring
Response
nextPageTokenstring
GET /cloud/v2/groups/{group}/memberships

curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group}/memberships?maxPageSize=10&pageToken={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
Response

{
"groupMemberships": [
{
"path": "groups/123/memberships/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/21557",
"role": "groups/7/roles/52"
}
],
"nextPageToken": "string"
}

GroupMembership

Update Group Membership
Beta

PATCH /cloud/v2/groups/{group}/memberships/{membership}
Scopes
group:write
RequestPath Parameters
groupstring
Required
membershipstring
Required
Request BodyGroupMembership
PATCH /cloud/v2/groups/{group}/memberships/{membership}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/groups/{group}/memberships/{membership}' \
-H 'x-api-key: {your-api-key}' \
--data '{ \
"user": "users/21557", \
"role": "groups/7/roles/52" \
}'
Response

{
"path": "groups/123/memberships/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/21557",
"role": "groups/7/roles/52"
}