Manage Roblox groups including memberships, roles, and group settings.

Common use cases include:

- Membership management: [Accept](#Cloud_AcceptGroupJoinRequest) or [decline](#Cloud_DeclineGroupJoinRequest) join requests and [manage member roles](#Cloud_UpdateGroupMembership)
- Role configuration: [Create](#groups_post_v1_groups__groupId__rolesets_create), [update](#groups_patch_v1_groups__groupId__rolesets__rolesetId_), and [delete](#groups_delete_v1_groups__groupId__rolesets__rolesetId_) group roles with custom permissions
- Audit logging: [Review group activity](#get_legacy_groups_v1_groups__groupId__audit_log) through audit logs


Assigns a role to the specified group membership.

The resource path of the role to assign.

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

The timestamp when the message was created.

The reactions to the message, if this feature is enabled for this message.

The timestamp when the message was last updated.

A mini-community within Roblox for communication, discussions, and more.

The timestamp when the group was created.

The description of the group.

Has a maximum limit of 1000 characters.

The name of the group.

Must be non-empty. Has a maximum limit of 50 characters.

Whether the group is locked.

A locked group is a group that has been
moderated/banned by Roblox.

The total number of members within a group.

The resource path of the owner.

If the group is abandoned and has no owner, this field is not returned.

The resource path of the group.

Format: `groups/{group_id}`

The timestamp when the group was last updated.

Whether the group has the verified badge.

Represents a forum category within a group for user discussions.

The timestamp when the group forum category was archived.

The resource path of the user who archived the group forum category.

The timestamp when the group forum category was created.

The resource path of the user who created the group forum category.

The display name of the group forum category.

The resource path of the group forum category.

Format: `groups/{group_id}/forum-categories/{group_forum_category_id}`

The timestamp when the group forum category was last updated.

Represents a forum comment on a group's forum post.

The resource path of the group forum comment.

Format:
`groups/{group_id}/forum-categories/{group_forum_category_id}/posts/{group_forum_post_id}/comments/{group_forum_comment_id}`

Represents a forum post within a group's forum category.

The timestamp when the group forum post was archived.

The resource path of the user who archived the group forum post.

The number of comments on the group forum post. This includes the first
comment (post content).

The timestamp when the group forum post was created.

The resource path of the group forum post.

Format:
`groups/{group_id}/forum-categories/{group_forum_category_id}/posts/{group_forum_post_id}`

The timestamp when the group forum post was last updated.

A request to join a group.

The `acceptRequests` permission is required.

The timestamp when the group join request was created.

The resource path of the group join request.

Format: `groups/{group_id}/join-requests/{group_join_request_id}`

A membership to a group. A user ID can be used in place of a membership ID.

The timestamp when the group membership was created.

The resource path of the group membership.

Format: `groups/{group_id}/memberships/{group_membership_id}`

The resource path of the member's highest-ranked role.
When the member holds multiple roles, this reflects only the
highest-ranked one. Prefer using the `roles` field, which always
contains the complete set of assigned roles.

The resource paths of all roles assigned to the group member.
This is the recommended field for reading a member's roles, as it
always contains the complete set of roles held by the member.

The timestamp when the group membership was last updated.

The resource path of a member of the group.

A configurable property to grant specific privileges for members within a
group.

The timestamp for when the group role was last updated.

Visible only to owners of the group.

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.

The name of the role.

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

A unique ID that identifies a role.

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

Total number of members within a role.

This field is not returned for guest roles.

The resource path of the group role.

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

The rank of the role.

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

The timestamp when the group role was last updated.

Visible only to owners of the group.

A list of GroupForumCategories in the parent collection.

The GroupForumCategories from the specified Group.

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.

A list of GroupForumComments in the parent collection.

The GroupForumComments from the specified GroupForumPost.

A list of GroupForumPosts in the parent collection.

The GroupForumPosts from the specified GroupForumCategory.

A list of GroupJoinRequests in the parent collection.

The GroupJoinRequests from the specified Group.

A list of GroupMemberships in the parent collection.

The GroupMemberships from the specified Group.

A list of GroupRoles in the parent collection.

A model containing information about a group

The Roblox.Platform.Groups.IGroup's name.

Represents a universe in API endpoint results.

The audiences this universe is visible to (e.g. Editors, PlayTesters, Friends, Public).
Always non-null; may be empty when audience visibility has not been configured.

The id of the user or group that created this universe.

The creator type, either "User" or "Group"

Response model representing the freeze status of a community feature.

Whether the feature is currently disabled.

Response model for the community feature freezes endpoint.

The freeze status of each community feature.

Response model for the group features endpoint.

The freeze status of each feature for the group.

Response model representing the freeze status of a group feature.

The UTC time at which the moderator-force expires, allowing the freeze to be deactivated upon request. Only present when the feature is forced frozen.

The feature type. ['Payouts' = 0, 'ContentUpload' = 1, 'GroupOwnershipTransfer' = 2, 'GameOwnershipTransfer' = 3, 'ForumRead' = 4, 'ForumWrite' = 5]

Request model for setting the desired status of group features.

Dictionary of features and their desired status.

Response model for setting the desired status of group features.

 ['OwnerModerationStatusOk' = 1, 'OwnerAgeEstimationVerified' = 2, 'OwnerIdVerified' = 3, 'OwnerTwoStepVerified' = 4, 'CommunityMeetsPlayerRequirement' = 5]

Unassigns a role from the specified group membership.

The resource path of the role to unassign.

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

A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.

x-api-key

A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.

.ROBLOSECURITY

Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.

The Roblox API. See https://create.roblox.com/docs/cloud/open-cloud for more details.

Roblox API

group_id

Group

Lists forum categories in the group. Supports filtering.

The maximum number of group forum categories to return. The service might
return fewer than this value. If unspecified, at most 10 group forum
categories are returned. The maximum value is 10 and higher values are set
to 10.

maxPageSize

A page token, received from a previous call, to retrieve a subsequent page.

When paginating, all other parameters provided to the subsequent call must
match the call that provided the page token.

pageToken

This field may be set in order to filter the resources returned.

Filtering conforms to Common Expression Language (CEL). Only the boolean
field `archived` and `==` operator are supported. If `archived=false`,
archived categories are not returned. The default value is `false`.
Example: `"filter=archived==true"`

filter

GroupForumCategory

group-forum:read

Lists forum posts in the group's forum category. Supports filtering.

forum_category_id

The maximum number of group forum posts to return. The service might return
fewer than this value. If unspecified, at most 10 group forum posts are
returned. The maximum value is 100 and higher values are set to 100.

This field may be set in order to filter the resources returned.

Filtering conforms to Common Expression Language (CEL). Only the query
`filter=pinned==true` is supported, where only pinned posts are returned.
`filter=pinned==false`is not supported.

The view in which to retrieve the group forum post.

Supports FULL and FULL_WITH_FIRST_COMMENT.

Defaults to FULL.

Possible values:

  | Value | Description |
  | --- | --- |
  | VIEW_UNSPECIFIED | The group forum post view is not specified; the default will be used. |
  | FULL | Includes all fields but does not dereference `first_comment`. Only the `path` field is populated. |
  | FULL_WITH_FIRST_COMMENT | Includes all fields and also fully populates `first_comment`. The default view. |

view

GroupForumPost

Lists forum comments on a group's forum post. Supports filtering.

post_id

The maximum number of group forum comments to return. The service might
return fewer than this value. If unspecified, at most 10 group forum
comments are returned. The maximum value is 100 and higher values are set
to 100.

This field may be set in order to filter the resources returned.

Filtering conforms to Common Expression Language (CEL). Only the string
field `repliesToCommentId` and the `==` operator are supported.
If `repliesToCommentId` is specified, only comments that respond to the
comment are returned. The default value is `''`. If
`repliesToCommentId=''`, only comments responding directly to the post are
returned. Example:
`"filter=repliesToCommentId==01234567-89ab-cdef-0123-456789abcdef"`

GroupForumComment

List join requests under a group. Supports filtering.

The maximum number of group join requests to return. The service might
return fewer than this value. If unspecified, at most 10 group join
requests are returned. The maximum value is 20 and higher values are set
to 20.

This field may be set in order to filter the resources returned.

Filtering conforms to Common Expression Language (CEL). Only the `user`
field and `==` operator are supported.


Example: `"user == 'users/156'"`

GroupJoinRequest

group:read

join_request_id

group:write

List group members in a group. Supports filtering.

The maximum number of group memberships to return. The service might return
fewer than this value. If unspecified, at most 10 group memberships are
returned. The maximum value is 100 and higher values are set to 100.

This field may be set in order to filter the resources returned.

See the
[filtering](/cloud/reference/patterns#list-group-memberships)
documentation for more information.

GroupMembership

**Deprecated.** Use AssignGroupRole and UnassignGroupRole instead.
Updates the group membership for a particular group member. This action
requires the requester to be able to assign or remove roles below their
highest role. The requester cannot change their own roles.

membership_id

Assigns a specific role to a user within a group. If the user already
holds the specified role, no action is taken.

Unassigns a specific role from a user within a group. If the user does
not hold the specified role, no action is taken.

List roles in a group.

Roles can be public or private. The response includes private roles and
their fields only when the acting user is permitted to view them. The
endpoint does not provide a public-roles-only view.

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.

The maximum number of group roles to return. The service might return fewer
than this value. If unspecified, at most 10 group roles are returned. The
maximum value is 20 and higher values are set to 20.

GroupRole

Required to view permissions in non-guest roles.

role_id

0: Authorization has been denied for this request.

Gets a list of Groups that a user can manage.

legacy-group:manage

groupIds

The thumbnail size, formatted widthxheight

size

format

The circle thumbnail output parameter, true or false

isCircular

1: There are too many requested Ids.
2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values.
3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format.
4: The requested Ids are invalid, of an invalid type or missing.
10: Circular thumbnail requests are not allowed

Fetches thumbnail URLs for a list of groups. Ids that do not correspond to groups will be filtered out.

groupId

Gets the freeze status of the community features for a group.

0: Token Validation Failed
22: The feature is disabled.
23: Insufficient permissions to complete the request.
49: User is invalid or does not exist

23: Insufficient permissions to complete the request.
49: User is invalid or does not exist

Gets the freeze status of all features and the lock status for a group.

0: Token Validation Failed
23: Insufficient permissions to complete the request.
49: User is invalid or does not exist

Sets the desired status of group features.
Currently only removes active freezes for features set to Roblox.Groups.Api.FeatureStatus.On.

isArchived

limit

The paging cursor for the previous or next page.

cursor

sortOrder

Gets a list of universes for the given group.

Gets a list of groups a user can manage games or items for.

Groups

Experiences

Avatar

Assets

Samples and projects

Engine API

Open Cloud API

Studio

Analytics

Platform

Tutorials

Creator programs

Education

Courses

Learn

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta endpoints are ready for public use. Breaking changes are possible but rare.

These Open Cloud documentation pages will be removed on March 31, 2026. You will be automatically redirected to the new Open Cloud documentation at that time. {linkStart}Learn more{linkEnd}

These old Open Cloud pages will be removed and redirected on March 31, 2026. {linkStart}Learn more{linkEnd}

Experimental endpoints are ready for public use, but may experience breaking changes occasionally as the API contract is finalized.

This endpoint can be called in-experience through {httpServiceLinkStart}HttpService{httpServiceLinkEnd} with an API key.

This field may be set when creating a resource, but may not be modified by subsequent requests.

These fields may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Legacy authentication method. Always prefer using API Key or OAuth 2.0 when available.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

Requires no authentication to call. Typically has significantly lowered rate limits. Always prefer using API Key or OAuth 2.0 when available.

For each grouping, only one of the following fields in the schema has to be provided, the remaining can be excluded.

You can opt back in at any time. {linkStart}Provide feedback.{linkEnd}

You are viewing the old docs. {linkStart}Provide feedback.{linkEnd}

You can opt out at any time and be redirected back to the old reference pages. {linkStart}Provide feedback.{linkEnd}

You are viewing the revamped docs. {linkStart}Provide feedback.{linkEnd}

This field may be set on responses, but will be ignored in requests.

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. [Learn more about rate limits]({link}).

{limit} requests per day across all API keys for a user or group

{limit} requests per hour across all API keys for a user or group

{limit} requests per minute across all API keys for a user or group

{limit} requests per second across all API keys for a user or group

{limit} requests per minute per API key owner

{limit} request(s) per second per API key owner

Scopes control what permissions your credentials have. Your credentials can only access the endpoints supported by the scopes you selected.

Stable endpoints are production-ready and will almost never experience breaking changes during their lifetime.

This target enables you to limit your key's access to selected {requiredParts}

This target enables you to limit your key's access to selected {requiredParts} and {optionalParts}

Target types are used to restrict the resources that your credentials have permissions on. Only the selected resources can be acted on even if your account has permissions on additional resources. Some scopes do not have target parts. In these cases, all of your relevant resources can be acted on.

The universe Top Level Part does not need to be selected for user-owned API Keys. In this case, your API Key will have access to all of your user-owned experiences and group-owned experiences that you have the right group permissions on.

Try It Out is not yet supported for endpoints requiring API key or OAuth 2.0 authentication

Cookie authentication is disabled for high risk operations for safety.

Critical risk endpoints are extremely sensitive and Try It Out is disabled for safety

Note: Authentication headers are not included in this code sample. You may need to add an authentication header for this command to work.

This is a high risk endpoint that can modify or delete critical data. Use extreme caution when testing.

This API endpoint has been classified as HIGH RISK and may affect live data or user accounts.

Authenticated requests to high-risk APIs can make changes that cannot be undone. Please review your request parameters carefully before proceeding.

Please login to use cookie authentication

This is a low risk endpoint that retrieves data. This is generally safe to test.

This is a medium risk endpoint that modifies data. Test carefully with non-critical accounts, as changes may be permanent.

To keep your account safe, never paste text here from other sources or send information from this page to others.

You are about to test live API endpoints using your actual account credentials.

Only proceed if you understand the implications of the API calls you're about to make. Review the API documentation carefully before testing.

API calls will be made using your authenticated session

These are real API calls that may affect your account or data

Rate limits and other API restrictions apply

Some operations may modify or delete data

This endpoint has been superseded by these recommended alternative endpoints:

The following scopes are required to call this endpoint. For more
information on generating proper keys, see [Manage API keys]({apiKeyReferenceDocLink}).

For more information on generating keys, see [Manage API keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

The following scopes are required to call this endpoint.

Resource Paths

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

Groups

Assets

Thumbnails

Universes

Users

Not Recommended