1. apireference
2. social
3. groupservice

GetGroupsAsync

Parameters

Name	Type	Default	Description
Name userId	Type int64	Default	Summary The Player/UserId of the user

Returns

Return Type	Summary
Return Type Array	Summary An array of dictionaries containing information on the group’s the Player is a member of

---

Code Samples

---

Getting the Groups that a User is A Member Of

This code sample will print information on all of the groups a player is a member of when they join the game, using GroupService/GetGroupsAsync.

    local GroupService = game:GetService("GroupService")
    local Players = game:GetService("Players")
    
    local function playerAdded(player)
    	-- load a list of info on all groups the player is a member of
    	local groups = GroupService:GetGroupsAsync(player.UserId)
    	
    	-- go through this list
    	for _, groupInfo in pairs(groups) do
    
    		-- print all of the entries
    		for key, value in pairs(groupInfo) do 
    			print(key..": "..tostring(value))
    		end
    
    		-- print a divider
    		print("--")
    	end
    end
    
    -- listen for new players
    Players.PlayerAdded:Connect(playerAdded)
    
    -- go through existing players
    for _, player in pairs(Players:GetPlayers()) do
    	playerAdded(player)
    end