Documentation

GetProfile

Retrieves the entity's profile.

Request Details

Given an entity type and entity identifier will retrieve the profile from the entity store. If the profile being retrieved is the caller's, then the read operation is consistent, if not it is an inconsistent read. An inconsistent read means that we do not guarantee all committed writes have occurred before reading the profile, allowing for a stale read. If consistency is important the Version Number on the result can be used to compare which version of the profile any reader has.

GetEntityProfileRequest
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.

Entity EntityKey

The entity to perform this action on.

POST https://{{TitleID}}.playfabapi.com/Profile/GetProfile
    Content-Type: application/json
{
  "Entity": {
    "Id": "1234567787392",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
        

Response Details

GetEntityProfileResponse
Result Properties
Profile EntityProfileBody

Entity profile

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Profile": {
      "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