/

Search skmtc

⌘K

Docs
History
Schema
Generate

Filter operations

Accounts198

Advertising24

Analytics17

Assets81

Avatars36

Badges29

Bans and blocks15

Configs9

Connections19

Creator Store8

Data and memory stores48

Developer products21

Experiments11

Game Events5

Game passes21

Generative AI1

Groups116

get/cloud/v2/groups/{group_id}Get Group
get/cloud/v2/groups/{group_id}/forum-categoriesList Group Forum Categories
get/cloud/v2/groups/{group_id}/forum-categories/{forum_category_id}/postsList Group Forum Posts
get/cloud/v2/groups/{group_id}/forum-categories/{forum_category_id}/posts/{post_id}/commentsList Group Forum Comments
get/cloud/v2/groups/{group_id}/join-requestsList Group Join Requests
post/cloud/v2/groups/{group_id}/join-requests/{join_request_id}:acceptAccept Group Join Request
post/cloud/v2/groups/{group_id}/join-requests/{join_request_id}:declineDecline Group Join Request
get/cloud/v2/groups/{group_id}/membershipsList Group Memberships
patch/cloud/v2/groups/{group_id}/memberships/{membership_id}Update Group Membership
post/cloud/v2/groups/{group_id}/memberships/{membership_id}:assignRoleAssign Role Group Membership
post/cloud/v2/groups/{group_id}/memberships/{membership_id}:unassignRoleUnassign Role Group Membership
get/cloud/v2/groups/{group_id}/rolesList Group Roles
get/cloud/v2/groups/{group_id}/roles/{role_id}Get Group Role
get/legacy-develop/v1/user/groups/canmanageGets a list of Groups that a user can manage.
post/legacy-groups/v1/groups/policiesGets group policy info used for compliance.
get/legacy-groups/v1/groups/{groupId}/audit-logGets the Group's audit log
patch/legacy-groups/v1/groups/{groupId}/descriptionUpdates the groups description
patch/legacy-groups/v1/groups/{groupId}/notification-preferenceUpdates the group's settings
get/legacy-groups/v1/groups/{groupId}/settingsGets the Group's settings
patch/legacy-groups/v1/groups/{groupId}/settingsUpdates the group's settings
patch/legacy-groups/v1/groups/{groupId}/statusSets group status
get/legacy-groups/v1/user/groups/pendingGets groups that the authenticated user has requested to join
get/v1/featured-content/eventGets the featured event for a group
post/v1/featured-content/eventSets the featured event for a group
delete/v1/featured-content/eventDeletes the featured event for a group
get/v1/groups/configuration/metadataGets Group configuration contextual information
post/v1/groups/createCreates a new group.
patch/v1/groups/iconUpdates the group icon.
get/v1/groups/iconsFetches thumbnail URLs for a list of groups. Ids that do not correspond to groups will be filtered out.
get/v1/groups/metadataGets Groups contextual information: Max number of groups a user can be part of. Current number of groups a user is a member of. Whether to show/hide certain features based on device type.
post/v1/groups/policiesGets group policy info used for compliance.
get/v1/groups/searchSearch for groups by keyword.
get/v1/groups/search/lookupLooks up groups by a name. Prioritizes an exact match as the first result.
get/v1/groups/search/metadataGet suggested groups and other miscellaneous information needed for the group/join page like flags
get/v1/groups/{groupId}Gets group information
get/v1/groups/{groupId}/audit-logGets the Group's audit log
post/v1/groups/{groupId}/change-ownerChanges the group owner to another user.
post/v1/groups/{groupId}/claim-ownershipClaims ownership of the group as the authenticated user
get/v1/groups/{groupId}/community-feature-freezesGets the freeze status of the community features for a group.
post/v1/groups/{groupId}/community-tier/evaluate
get/v1/groups/{groupId}/configurationGets group configuration information
post/v1/groups/{groupId}/deactivateDeactivates the group as its owner.
patch/v1/groups/{groupId}/descriptionUpdates the groups description
get/v1/groups/{groupId}/emotesGets a groups emote sets.
get/v1/groups/{groupId}/featuresGets the freeze status of all features and the lock status for a group.
patch/v1/groups/{groupId}/featuresSets the desired status of group features. Currently only removes active freezes for features set to Roblox.Groups.Api.FeatureStatus.On.
get/v1/groups/{groupId}/features/statusChecks whether a group has ANY feature disabled (includes feature freezes and group lock). Used to display a banner on Creator Hub/Studio to inform group members that some features may not be available.
get/v1/groups/{groupId}/join-requestsGets a page of Group Join Requests for a group.
post/v1/groups/{groupId}/join-requestsBatch accepts group join requests
delete/v1/groups/{groupId}/join-requestsBatch declines group join requests
get/v1/groups/{groupId}/join-requests/users/{userId}Gets a group join request by userId.
post/v1/groups/{groupId}/join-requests/users/{userId}Accepts a group join request.
delete/v1/groups/{groupId}/join-requests/users/{userId}Declines/cancels a group join request.
get/v1/groups/{groupId}/membershipGets group membership information in the context of the authenticated user
patch/v1/groups/{groupId}/nameUpdates the group's name.
get/v1/groups/{groupId}/name-historyGets the Group's name change history.
patch/v1/groups/{groupId}/notification-preferenceUpdates the group's settings
get/v1/groups/{groupId}/payout-restrictionGets a value indicating whether the group can use payout feature
get/v1/groups/{groupId}/payoutsGets a list of the group payout percentages
post/v1/groups/{groupId}/payoutsPays out a user in Robux.
get/v1/groups/{groupId}/payouts/latestGets the latest one-time payout for each requested user.
post/v1/groups/{groupId}/payouts/recurringUpdates recurring payouts.
get/v1/groups/{groupId}/payouts/suggestedGets suggested one-time payouts for eligible collaborators.
get/v1/groups/{groupId}/payouts/universesGets payout-visible universes for a group.
get/v1/groups/{groupId}/relationships/{groupRelationshipType}Gets a group's relationships
get/v1/groups/{groupId}/relationships/{groupRelationshipType}/requestsGets a group's relationship requests
post/v1/groups/{groupId}/relationships/{groupRelationshipType}/requestsCreate a group relationship.
delete/v1/groups/{groupId}/relationships/{groupRelationshipType}/requestsDeletes a group relationship.
post/v1/groups/{groupId}/relationships/{groupRelationshipType}/requests/{relatedGroupId}Accepts a group relationship request.
delete/v1/groups/{groupId}/relationships/{groupRelationshipType}/requests/{relatedGroupId}Declines a group relationship request.
post/v1/groups/{groupId}/relationships/{groupRelationshipType}/{relatedGroupId}Create a group relationship.
delete/v1/groups/{groupId}/relationships/{groupRelationshipType}/{relatedGroupId}Deletes a group relationship.
get/v1/groups/{groupId}/revenue/summary/{timeFrame}
get/v1/groups/{groupId}/rolesGets a list of the rolesets in a group.
get/v1/groups/{groupId}/roles/guest/permissionsGets the permissions for a group's guest roleset. These can be viewed by all (members and guests) users.
get/v1/groups/{groupId}/roles/permissionsGets all permissions for each role
get/v1/groups/{groupId}/roles/{roleSetId}/permissionsGets the permissions for a group's roleset. The authorized user must either be the group owner or the roleset being requested, except for guest roles, which can be viewed by all (members and guests).
patch/v1/groups/{groupId}/roles/{roleSetId}/permissionsUpdates the permissions for a group's roleset. The authorized user must be the group owner.
get/v1/groups/{groupId}/roles/{roleSetId}/usersGets a list of users in a group for a specific roleset.
post/v1/groups/{groupId}/rolesets/createCreates new group roleset.
delete/v1/groups/{groupId}/rolesets/{rolesetId}Deletes existing group roleset.
patch/v1/groups/{groupId}/rolesets/{rolesetId}Updates existing group roleset.
get/v1/groups/{groupId}/settingsGets the Group's settings
patch/v1/groups/{groupId}/settingsUpdates the group's settings
get/v1/groups/{groupId}/social-linksGet social link data associated with a group
post/v1/groups/{groupId}/social-linksPosts a social links
delete/v1/groups/{groupId}/social-links/{socialLinkId}Deletes a social link
patch/v1/groups/{groupId}/social-links/{socialLinkId}Updates a social link
get/v1/groups/{groupId}/universesGets a list of universes for the given group.
get/v1/groups/{groupId}/usersGets a list of users in a group.
post/v1/groups/{groupId}/usersJoins a group
delete/v1/groups/{groupId}/users/{userId}Removes a user from a group
patch/v1/groups/{groupId}/users/{userId}Updates a users role in a group.
get/v1/groups/{groupId}/users/{userId}/permissionsGets the permissions a user has in a group. Only available to group owner and RCC
get/v1/rolesGets the Roles by their ids.
get/v1/universes/{universeId}/payoutsGets recurring payouts for a group-owned universe.
patch/v1/universes/{universeId}/payoutsUpdates recurring payouts for a group-owned universe.
get/v1/user/groups/canmanageGets a list of Groups that a user can manage.
get/v1/user/groups/pendingGets groups that the authenticated user has requested to join
post/v1/user/groups/primarySets the authenticated user's primary group
delete/v1/user/groups/primaryRemoves the authenticated user's primary group
get/v1/users/{userId}/groups/primary/roleGets a user's primary group.
get/v1/users/{userId}/groups/rolesGets a list of all group roles for groups the specified user is in.
patch/v1/vip-servers/{id}/permissions
get/v2/groupsMulti-get groups information by Ids.
get/v2/groups/{groupId}/gamesGets experiences created by the specified group id.
get/v2/groups/{groupId}/gamesV2Gets experiences created by the specified group id.
get/v2/groups/{groupId}/invitationsList open invitations to a group
post/v2/groups/{groupId}/invitationsInvite a user to a group
get/v2/groups/{groupId}/invitations/{invitationId}Get an invitation to a group
delete/v2/groups/{groupId}/invitations/{invitationId}Revoke an invitation to a group (member manager)
patch/v2/groups/{groupId}/invitations/{invitationId}Accept or decline an invitation to a group (recipient)
get/v2/groups/{groupId}/roles/{roleId}/invitationsList open invitations to a group that grant a role
get/v2/groups/{groupId}/transactions
get/v2/groups/{groupId}/users/{userId}/invitationGet the open invitation to a group for a user
get/v2/users/{userId}/groups/rolesGets a list of all group roles for groups the specified user is in.

Interactions26

Inventories9

Localization96

Luau Execution5

Matchmaking33

Metadata16

Notifications11

Observability6

Places23

Private servers9

Service Efficiency2

Team Create8

Thumbnail Personalization7

Thumbnails11

Trades16

Universes38

User profiles5

Users13

get/v2/beta-program-channel-versionGet the channel and current version guid of a beta program the currently logged in user may use, whether or not they are opted in to it. Only Studio binary types (MacStudio, WindowsStudio64) are supported for now.

Groups

Changes to Deactivates the group as its owner.

post/v1/groups/{groupId}/deactivate

Oct 14, 20265dcfa33df56a Revision changes
- info
  endpoint added