Creator Hub
Dashboard
Learn
Store
Talent
Forum
Roadmap
Log In
Create
Overview
Experiences
Avatar
Assets
Open Cloud
Roblox Studio has increased the minimum specification requirements.
Learn More
Create
/
Open Cloud
/
All legacy APIs
English
Feedback
Groups v1
Base URL
https://groups.roblox.com
JSON
Download
FeaturedContent
DELETE
/v1
/featured-content
/event
Deletes the featured event for a group
GET
/v1
/featured-content
/event
Gets the featured event for a group
POST
/v1
/featured-content
/event
Sets the featured event for a group
Groups
GET
/v1
/groups
/{groupId}
Gets group information
GET
/v1
/groups
/{groupId}
/audit-log
Gets the Group's audit log
GET
/v1
/groups
/{groupId}
/name-history
Gets the Group's name change history.
GET
/v1
/groups
/{groupId}
/settings
Gets the Group's settings
PATCH
/v1
/groups
/{groupId}
/settings
Updates the group's settings
GET
/v1
/groups
/configuration
/metadata
Gets Group configuration contextual information
GET
/v1
/groups
/metadata
Gets 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
/create
Creates a new group.
POST
/v1
/groups
/policies
Gets group policy info used for compliance.
PATCH
/v1
/groups
/{groupId}
/description
Updates the groups description
PATCH
/v1
/groups
/{groupId}
/name
Updates the group's name.
PATCH
/v1
/groups
/{groupId}
/notification-preference
Updates the group's settings
PATCH
/v1
/groups
/{groupId}
/status
Sets group status
PATCH
/v1
/groups
/icon
Updates the group icon.
Membership
DELETE
/v1
/groups
/{groupId}
/join-requests
Batch declines group join requests
GET
/v1
/groups
/{groupId}
/join-requests
Gets a page of Group Join Requests for a group.
POST
/v1
/groups
/{groupId}
/join-requests
Batch accepts group join requests
DELETE
/v1
/groups
/{groupId}
/join-requests
/users
/{userId}
Declines/cancels a group join request.
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.
GET
/v1
/groups
/{groupId}
/membership
Gets group membership information in the context of the authenticated user
GET
/v1
/groups
/{groupId}
/roles
Gets a list of the rolesets in a group.
GET
/v1
/groups
/{groupId}
/roles
/{roleSetId}
/users
Gets a list of users in a group for a specific roleset.
GET
/v1
/groups
/{groupId}
/users
Gets a list of users in a group.
POST
/v1
/groups
/{groupId}
/users
Joins a group
GET
/v1
/user
/groups
/pending
Gets groups that the authenticated user has requested to join
GET
/v1
/users
/{userId}
/friends
/groups
/roles
Gets a list of all groups the specified users' friends are in.
GET
/v1
/users
/{userId}
/groups
/roles
Gets a list of all group roles for groups the specified user is in.
POST
/v1
/groups
/{groupId}
/change-owner
Changes the group owner to another user.
POST
/v1
/groups
/{groupId}
/claim-ownership
Claims ownership of the group as the authenticated user
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.
Revenue
GET
/v1
/groups
/{groupId}
/payout-restriction
Gets a value indicating whether the group can use payout feature
GET
/v1
/groups
/{groupId}
/payouts
Gets a list of the group payout percentages
POST
/v1
/groups
/{groupId}
/payouts
Pays out a user in Robux.
POST
/v1
/groups
/{groupId}
/payouts
/recurring
Updates recurring payouts.
Relationships
GET
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
Gets a group's relationships
DELETE
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
Batch declines group affiliate requests
GET
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
Gets a group's relationship requests
POST
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
Batch accepts group affiliate requests
DELETE
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/{relatedGroupId}
Deletes a group relationship.
POST
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/{relatedGroupId}
Create a group relationship.
DELETE
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
/{relatedGroupId}
Declines a group relationship request.
POST
/v1
/groups
/{groupId}
/relationships
/{groupRelationshipType}
/requests
/{relatedGroupId}
Accepts a group relationship request.
Permissions
GET
/v1
/groups
/{groupId}
/roles
/{roleSetId}
/permissions
Gets 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}
/permissions
Updates the permissions for a group's roleset. The authorized user must be the group owner.
GET
/v1
/groups
/{groupId}
/roles
/guest
/permissions
Gets the permissions for a group's guest roleset. These can be viewed by all (members and guests) users.
GET
/v1
/groups
/{groupId}
/roles
/permissions
Gets all permissions for each role
GET
/v1
/groups
/{groupId}
/users
/{userId}
/permissions
Gets the permissions a user has in a group. Only available to group owner and RCC
SocialLinks
GET
/v1
/groups
/{groupId}
/social-links
Get social link data associated with a group
POST
/v1
/groups
/{groupId}
/social-links
Posts 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
Wall
GET
/v1
/groups
/{groupId}
/wall
/posts
Gets a list of group wall posts.
POST
/v1
/groups
/{groupId}
/wall
/posts
Creates a post on a group wall
POST
/v1
/groups
/{groupId}
/wall
/subscribe
Subscribes the authenticated user to notifications of group wall events.
DELETE
/v1
/groups
/{groupId}
/wall
/posts
/{postId}
Deletes a group wall post.
DELETE
/v1
/groups
/{groupId}
/wall
/users
/{userId}
/posts
Deletes all group wall posts made by a specific user.
GroupSearch
GET
/v1
/groups
/search
Search for groups by keyword.
GET
/v1
/groups
/search
/lookup
Looks up groups by a name. Prioritizes an exact match as the first result.
GET
/v1
/groups
/search
/metadata
Get suggested groups and other miscellaneous information needed for the group/join page like flags
Roles
GET
/v1
/roles
Gets the Roles by their ids.
PrimaryGroup
GET
/v1
/users
/{userId}
/groups
/primary
/role
Gets a user's primary group.
DELETE
/v1
/user
/groups
/primary
Removes the authenticated user's primary group
POST
/v1
/user
/groups
/primary
Sets the authenticated user's primary group
RoleSets
POST
/v1
/groups
/{groupId}
/rolesets
/create
Creates new group roleset.
DELETE
/v1
/groups
/{groupId}
/rolesets
/{rolesetId}
Deletes existing group roleset.
PATCH
/v1
/groups
/{groupId}
/rolesets
/{rolesetId}
Updates existing group roleset.
Models
Models
Roblox.Groups.Api.ChangeOwnerRequest
Roblox.Groups.Api.CreateWallPostRequest
Roblox.Groups.Api.GroupAllRolesResponse
Roblox.Groups.Api.GroupAuditLogPageResponse[Roblox.Groups.Api.Models.Response.GroupAuditLogResponseItem]
Roblox.Groups.Api.GroupConfigurationDisplayOptionsResponse
Roblox.Groups.Api.GroupConfigurationResponse
Roblox.Groups.Api.GroupDescriptionResponse
Roblox.Groups.Api.GroupDetailResponse
Roblox.Groups.Api.GroupEconomyPermissionsModel
Roblox.Groups.Api.GroupForumsPermissionsModel
Roblox.Groups.Api.GroupJoinRequestResponse
Roblox.Groups.Api.GroupManagementPermissionsModel
Roblox.Groups.Api.GroupMembershipDetailResponse
Roblox.Groups.Api.GroupMembershipMetadataResponse
Roblox.Groups.Api.GroupMembershipPermissionsModel
Roblox.Groups.Api.GroupNameChangeConfigurationResponse
Roblox.Groups.Api.GroupNotificationPreferenceData
Roblox.Groups.Api.GroupOpenCloudPermissionsModel
Roblox.Groups.Api.GroupPayoutResponse
Roblox.Groups.Api.GroupPayoutRestrictionResponse
Roblox.Groups.Api.GroupPermissionsModel
Roblox.Groups.Api.GroupPermissionsResponse
Roblox.Groups.Api.GroupPoliciesResponse
Roblox.Groups.Api.GroupPolicyRequest
Roblox.Groups.Api.GroupPolicyResponse
Roblox.Groups.Api.GroupPostsPermissionsModel
Roblox.Groups.Api.GroupRelationshipsResponse
Roblox.Groups.Api.GroupRoleDetailResponse
Roblox.Groups.Api.GroupRoleResponse
Roblox.Groups.Api.GroupSearchMetadataResponse
Roblox.Groups.Api.GroupSearchPageResponse
Roblox.Groups.Api.GroupSearchResponseItem
Roblox.Groups.Api.GroupSettingsResponse
Roblox.Groups.Api.GroupsDisplayOptionsResponse
Roblox.Groups.Api.JoinGroupRequest
Roblox.Groups.Api.MembersRequest
Roblox.Groups.Api.Models.Request.CreateRoleSetRequest
Roblox.Groups.Api.Models.Request.UpdateRoleSetRequest
Roblox.Groups.Api.Models.Response.GroupAuditLogResponseItem
Roblox.Groups.Api.Models.Response.GroupNameHistoryResponseItem
Roblox.Groups.Api.Models.Response.GroupWallPostModel
Roblox.Groups.Api.Models.Response.UserModel
Roblox.Groups.Api.PayoutRecipientRequest
Roblox.Groups.Api.PayoutRequest
Roblox.Groups.Api.PostGroupStatusRequest
Roblox.Groups.Api.PrimaryGroupRequest
Roblox.Groups.Api.RecurringPayoutsConfigurationResponse
Roblox.Groups.Api.RelationshipsRequest
Roblox.Groups.Api.RoleConfigurationResponse
Roblox.Groups.Api.ShoutResponse
Roblox.Groups.Api.SocialLinkRequest
Roblox.Groups.Api.SocialLinkResponse
Roblox.Groups.Api.UpdateGroupDescriptionRequest
Roblox.Groups.Api.UpdateGroupNameRequest
Roblox.Groups.Api.UpdateGroupNameResponse
Roblox.Groups.Api.UpdateGroupNotificationPreferenceRequest
Roblox.Groups.Api.UpdateGroupSettingsRequest
Roblox.Groups.Api.UpdatePermissionsRequest
Roblox.Groups.Api.UpdateUserRoleRequest
Roblox.Groups.Api.UserGroupMembershipResponse
Roblox.Groups.Api.UserGroupRoleResponse
Roblox.Groups.Client.GroupFeaturedContentResponse
Roblox.Paging.ExclusiveStartKeyCursor[System.String]
Roblox.Paging.StartIndexCursor
Roblox.Platform.Core.ExclusiveStartPaging.IExclusiveStartKeyInfo[System.Int32]
Roblox.Platform.Core.ExclusiveStartPaging.IExclusiveStartKeyInfo[System.Int64]
Roblox.Web.Responses.Groups.GroupBasicResponse
Roblox.Web.Responses.Groups.GroupResponseV2
Roblox.Web.Responses.RelatedEntityTypeResponse[Roblox.Web.Responses.Groups.GroupOwnerType]
Roblox.Web.WebAPI.ApiEmptyResponseModel
Roblox.Web.WebAPI.ExclusiveStartRequest[System.Int32]
Roblox.Web.WebAPI.ExclusiveStartRequest[System.Int64]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupDetailResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupMembershipDetailResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupPayoutResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupPermissionsResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.GroupRoleDetailResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.SocialLinkResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Groups.Api.UserGroupMembershipResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Web.Responses.Groups.GroupBasicResponse]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.GroupJoinRequestResponse]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.Models.Response.GroupNameHistoryResponseItem]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.Models.Response.GroupWallPostModel]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.Models.Response.UserModel]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Groups.Api.UserGroupRoleResponse]
Roblox.Web.WebApi.FormData.IUploadedFile
System.IO.Stream
System.ValueTuple[Roblox.Web.WebAPI.ExclusiveStartRequest[System.Int64],Roblox.Paging.ExclusiveStartKeyCursor[System.String]]