Documentation

GetPlayerCombinedInfo

Retrieves all of the user's different kinds of info.

Request Details

GetPlayerCombinedInfoRequest
Request Properties
InfoRequestParameters (required) GetPlayerCombinedInfoRequestParams

Flags for which pieces of info to return for the user.

PlayFabId String

PlayFabId of the user whose data will be returned. If not filled included, we return the data for the calling player.

POST https://{{TitleID}}.playfabapi.com/Client/GetPlayerCombinedInfo
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "PlayFabId": "4027527BF22653D1",
  "InfoRequestParameters": {
    "GetUserAccountInfo": true,
    "GetUserInventory": false,
    "GetUserVirtualCurrency": true,
    "GetUserData": true,
    "UserDataKeys": [
      "preferences",
      "progress"
    ],
    "GetUserReadOnlyData": false,
    "GetCharacterInventories": false,
    "GetCharacterList": false,
    "GetTitleData": false,
    "GetPlayerStatistics": false,
    "GetPlayerProfile": false
  }
}
        

Response Details

Returns whatever info is requested in the response for the user. If no user is explicitly requested this defaults to the authenticated user. If the user is the same as the requester, PII (like email address, facebook id) is returned if available. Otherwise, only public information is returned. All parameters default to false.

GetPlayerCombinedInfoResult
Result Properties
InfoResultPayload GetPlayerCombinedInfoResultPayload

Results for requested info.

PlayFabId String

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "PlayFabId": "4027527BF22653D1",
    "InfoResultPayload": {
      "AccountInfo": {
        "PlayFabId": "4027527BF22653D1",
        "Created": "2013-04-07T09:04:28Z",
        "Username": "my name",
        "TitleInfo": {
          "Origination": "IOS",
          "Created": "2014-01-08T11:03:18Z",
          "LastLogin": "2014-04-07T09:04:28Z",
          "FirstLogin": "2014-01-08T11:03:18Z",
          "TitlePlayerAccount": {
            "Id": "174812abf712",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
          }
        },
        "FacebookInfo": {
          "FacebookId": "23525445454"
        },
        "SteamInfo": {
          "SteamCountry": "US",
          "SteamCurrency": "USD"
        },
        "GameCenterInfo": {
          "GameCenterId": "someone"
        }
      },
      "UserVirtualCurrency": {
        "GC": 15
      },
      "UserVirtualCurrencyRechargeTimes": {
        "GC": {
          "SecondsToRecharge": 3600,
          "RechargeTime": "2014-01-01T12:00:00Z",
          "RechargeMax": 50
        }
      },
      "UserData": {
        "preferences": {
          "Value": "alpha",
          "LastUpdated": "2014-08-20T12:30:45Z",
          "Permission": "Public"
        },
        "progress": {
          "Value": "level_twenty",
          "LastUpdated": "2014-09-01T10:12:30Z",
          "Permission": "Private"
        }
      },
      "UserDataVersion": 12,
      "UserReadOnlyDataVersion": 0,
      "PlayerProfile": {
        "TitleId": "TitleName",
        "PlayerId": "10931252888739651331",
        "Created": "0001-01-01T00:00:00Z",
        "LastLogin": "0001-01-01T00:00:00Z",
        "BannedUntil": "9999-12-31T23:59:59.999Z",
        "DisplayName": "PlayerDisplayName",
        "TotalValueToDateInUSD": 0
      }
    }
  }
}

Authentication

SessionTicket

Possible Error Codes

Name Code
AccountNotFound 1001
RequestViewConstraintParamsNotAllowed 1303