Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. Shared Groups are designed for sharing data between a very small number of players, please see our guide:

Request Details

Request Properties
GetMembers Boolean

If true, return the list of all members of the shared group.

Keys List<String>

Specific keys to retrieve from the shared group (if not specified, all keys will be returned, while an empty array indicates that no keys should be returned).

SharedGroupId (required) String

Unique identifier for the shared group.

POST https://{{TitleID}}
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
  "SharedGroupId": "Clan Data",
  "Keys": [
  "GetMembers": true

Response Details

Result Properties
Data Dict<String, SharedGroupDataRecord>

Data for the requested keys.

Members List<String>

List of PlayFabId identifiers for the members of this group, if requested.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
  "code": 200,
  "status": "OK",
  "data": {
    "Data": {
      "ClanKills": {
        "Value": "34",
        "LastUpdatedBy": "D984A64B832",
        "LastUpdated": "2015-01-03T17:44:21Z",
        "Permission": "Public"
      "LastClanUpdate": {
        "Value": "2015-01-03T17:44:21Z",
        "LastUpdatedBy": "D984A64B832",
        "LastUpdated": "2015-01-03T17:44:21Z",
        "Permission": "Private"
    "Members": [



Possible Error Codes

Name Code