13 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GroupService

Inherits from: Instance → Object

GroupService is a service that allows developers to fetch information about a Roblox group from within a game.

Basic information on the group, including its name, description, owner, roles and emblem can be fetched using GroupService:GetGroupInfoAsync(). Lists of a group's allies and enemies can be fetched using GroupService:GetAlliesAsync() and GroupService:GetEnemiesAsync().

GroupService can also be used to fetch a list of groups a player is a member of, using GroupService:GetGroupsAsync(). If you wish to verify if a player is in a group, use the Player:IsInGroupAsync() method rather than GroupService:GetGroupsAsync().

The service has a number of useful applications, such as detecting if a player is an ally or enemy upon joining the game, or prompting a player to join a group using the GroupService:PromptJoinAsync() method.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, Service, NotReplicated

Code samples: View on Creator Hub (Group-Ally-Enemy-Checker).

Methods

Inherited from Instance

Inherited from Object

GroupService:GetAlliesAsync

Returns a StandardPages object including information on all of the specified group's allies.

This pages does not include a list of group IDs but instead a list of group information tables, mirroring the format of those returned by GroupService:GetGroupInfoAsync(). See below for the structure of these tables.

group = {
    Name = "Knights of the Seventh Sanctum",
    Id = 377251,
    Owner = {
        Name = "Vilicus",
        Id = 23415609
    },
    EmblemUrl = "http://www.roblox.com/asset/?id=60428602",
    Description = "We fight alongside the balance to make sure no one becomes too powerful",
    Roles = {
        [1] = {
            Name = "Apprentice",
            Rank = 1
        },
        [2] = {
            Name = "Warrior",
            Rank = 2
        },
        [3] = {
            Name = "Earth Walker",
            Rank = 255
        }
    }
}

Note, as this function returns a StandardPages object rather than an array, developers may wish to convert it to an array for ease of use (see examples).

This function has a number of useful applications, including detecting if a player is a member of an allied group.

For enemies, use GroupService:GetEnemiesAsync().

Parameters

Returns

Code samples: View on Creator Hub (GroupService-GetAlliesAsync1, Group-Ally-Enemy-Checker).

GroupService:GetEnemiesAsync

Returns a StandardPages object including information on all of the specified group's enemies.

This pages does not include a list of group IDs but instead a list of group information tables, mirroring the format of those returned by GroupService:GetGroupInfoAsync(). See below for the structure of these tables.

group = {
    Name = "Knights of the Seventh Sanctum",
    Id = 377251,
    Owner = {
        Name = "Vilicus",
        Id = 23415609
    },
    EmblemUrl = "http://www.roblox.com/asset/?id=60428602",
    Description = "We fight alongside the balance to make sure no one becomes too powerful",
    Roles = {
        [1] = {
            Name = "Apprentice",
            Rank = 1
        },
        [2] = {
            Name = "Warrior",
            Rank = 2
        },
        [3] = {
            Name = "Earth Walker",
            Rank = 255
        }
    }
}

Note, as this function returns a StandardPages object rather than an array, developers may wish to convert it to an array for ease of use (see examples).

This function has a number of useful applications, including detecting if a player is a member of an enemy group.

For allies, use GroupService:GetAlliesAsync().

Parameters

Returns

Code samples: View on Creator Hub (GroupService-GetEnemiesAsync1, Group-Ally-Enemy-Checker).

GroupService:GetGroupInfoAsync

Returns a table containing information about the given group.

The table returned is the same format as that returned in GroupService:GetAlliesAsync() and GroupService:GetEnemiesAsync(). This format can be seen below.

group = {
    Name = "Knights of the Seventh Sanctum",
    Id = 377251,
    Owner = {
        Name = "Vilicus",
        Id = 23415609
    },
    EmblemUrl = "http://www.roblox.com/asset/?id=60428602",
    Description = "We fight alongside the balance to make sure no one becomes too powerful",
    Roles = {
        [1] = {
            Name = "Apprentice",
            Rank = 1
        },
        [2] = {
            Name = "Warrior",
            Rank = 2
        },
        [3] = {
            Name = "Earth Walker",
            Rank = 255
        }
    }
}

Note, if a group has no owner the Owner field will be set to nil.

This function has a number of useful applications, including loading the latest description and logo of a group for display in a group base.

Parameters

Returns

Code samples: View on Creator Hub (GroupService-GetGroupInfoAsync1, Load-Group-Emblem).

GroupService:GetGroupsAsync

This function returns a list of tables containing information on all of the groups a given Player is a member of.

The list returned will include an entry for every group the player is a member of. These entries are tables with the following fields.

Note unlike GroupService:GetAlliesAsync() and GroupService:GetEnemiesAsync(), GetGroupsAsync returns a table rather than a StandardPages object.

Parameters

Returns

Code samples: View on Creator Hub (GetGroupsAsync).

GroupService:GetRolesInGroupAsync

Returns a table describing all roles the specified user holds in the specified group. In a multi-role world, a user may belong to more than one role simultaneously.

The returned table has the following structure:

Each entry in the Roles array has the following structure:

The Roles array is ordered from the highest role to the lowest role. Only public roles are included. A role's Rank value is retained for backwards compatibility, but does not determine its position in the role hierarchy. Use the stable Id to identify a role.

This method supersedes Player:GetRankInGroupAsync() and Player:GetRoleInGroupAsync(), which return only the member's highest public role.

This call may not yield the most up-to-date information. Results are cached per user and group, so multiple calls with the same userId and groupId may yield the same result until the cache expires. The caching behavior is on a per-peer basis: a server does not share the same cache as a client.

When a player joins a group in-experience due to a call to GroupService:PromptJoinAsync(), any cached result for that player and group will be cleared on the client where the prompt was shown.

Parameters

Returns

Code samples: View on Creator Hub (GroupService-GetRolesInGroupAsync).

GroupService:PromptJoinAsync

PromptJoinAsync() displays a prompt to the local player through which they may join the specified Roblox group. The group must exist and the player must meet the eligibility criteria to join. If the player is ineligible, this method will return GroupMembershipStatus.None.

Note that you can use Player:IsInGroupAsync() to check the player's current membership status before calling this method.

If the player successfully joins, any cached results from GroupService:GetRolesInGroupAsync(), Player:GetRankInGroupAsync(), and Player:GetRoleInGroupAsync() for that player and group will be cleared on the client where the prompt was shown.

Parameters

Returns

Code samples: View on Creator Hub (GroupService-PromptJoinAsync1).

Properties

Inherited from Instance

Inherited from Object

Events

Inherited from Instance

Inherited from Object