Documentation

GetProfiles

Retrieves the entity's profile.

Request Details

Given a set of entity types and entity identifiers will retrieve all readable profiles properties for the caller. Profiles that the caller is not allowed to read will silently not be included in the results.

GetEntityProfilesRequest
Request Properties
DataAsObject Boolean

Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON string.

Entities (required) List<EntityKey>

Entity keys of the profiles to load. Must be between 1 and 25

POST https://{{TitleID}}.playfabapi.com/Profile/GetProfiles
    Content-Type: application/json
{
  "Entities": [
    {
      "Id": "1234567787392",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    },
    {
      "Id": "42434567785265",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    }
  ]
}
        

Response Details

GetEntityProfilesResponse
Result Properties
Profiles List<EntityProfileBody>

Entity profiles

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Profiles": [
      {
        "Entity": {
          "Id": "1234567787392",
          "Type": "title_player_account",
          "TypeString": "title_player_account"
        },
        "EntityChain": "title_player_account!09839712/1289749013/19073097/1234567787392",
        "VersionNumber": 0
      }
    ]
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
NotAuthenticated 1074
NotAuthorized 1089
ProfileDoesNotExist 1298