Returns the list of the current players game friends.

A Game friend is someone in their social network who also plays the game.

Against each friend, an indicator is supplied to show whether the friend is currently connected to the GameSparks service

View interactive version here

Request Parameters

Parameter Required Type Description

Response Parameters

A response containing the list of the current players game friends.

Parameter Type Description
friends Player[] A list of JSON objects containing game friend data
scriptData ScriptData A JSON Map of any data added either to the Request or the Response by your Cloud Code

Nested types


A collection of arbitrary data that can be added to a message via a Cloud Code script.

Parameter Type Description
myKey string An arbitrary data key
myValue JSON An arbitrary data value.


A nested object that represents a player.

Parameter Type Description
achievements string[] The achievements of the Player
displayName string The display name of the Player
externalIds JSON The external Id's of the Player
id string The Id of the Player
online boolean The online status of the Player
scriptData JSON The script data of the Player
virtualGoods string[] The virtual goods of the Player

Code Samples


    using GameSparks.Api;
    using GameSparks.Api.Requests;
    using GameSparks.Api.Responses;
    new ListGameFriendsRequest()
        .Send((response) => {
        GSEnumerable<ListGameFriendsResponse._Player> friends = response.Friends;
        GSData scriptData = response.ScriptData;

ActionScript 3

    import com.gamesparks.*;
    import com.gamesparks.api.requests.*;
    import com.gamesparks.api.responses.*;
    import com.gamesparks.api.types.*;

        .send(function(response:com.gamesparks.api.responses.ListGameFriendsResponse):void {
        var friends:Vector.<Player> = response.getFriends(); 
        var scriptData:ScriptData = response.getScriptData(); 


    #import "GS.h"
    #import "GSAPI.h"
    GSListGameFriendsRequest* request = [[GSListGameFriendsRequest alloc] init];
    [request setCallback:^ (GSListGameFriendsResponse* response) {
    NSArray* friends = [response getFriends]; 
    NSDictionary* scriptData = [response getScriptData]; 
    [gs send:request];


    #include <GameSparks/generated/GSRequests.h>
    using namespace GameSparks::Core;
    using namespace GameSparks::Api::Responses;
    using namespace GameSparks::Api::Requests;

    void ListGameFriendsRequest_Response(GS& gsInstance, const ListGameFriendsResponse& response) {
    gsstl:vector<Types::Player*> friends = response.getFriends(); 
    GSData scriptData = response.getScriptData(); 

    ListGameFriendsRequest request(gsInstance);


import com.gamesparks.sdk.api.autogen.GSRequestBuilder.ListGameFriendsRequest;
import com.gamesparks.sdk.api.autogen.GSResponseBuilder.ListGameFriendsResponse;
import com.gamesparks.sdk.api.autogen.GSTypes.*;
import com.gamesparks.sdk.api.GSEventListener;

    .send(new GSEventListener<ListGameFriendsResponse>() {
        public void onEvent(ListGameFriendsResponse response) {
            List<Player> friends = response.getFriends(); 

Cloud Code

    var request = new SparkRequests.ListGameFriendsRequest();
    var response = request.Send();

var friends = response.friends; 
var scriptData = response.scriptData;