Documentation

GetObjects

  1. Services
  2. Data
  3. Object
  4. GetObjects

Retrieves objects from an entity's profile.

Request Details

Gets JSON objects from an entity profile and returns it.

GetObjectsRequest
Request Properties
Entity (required) EntityKey

The entity to perform this action on.
EscapeObject Boolean

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

 
POST https://{{TitleID}}.playfabapi.com/Object/GetObjects
    Content-Type: application/json
{
  "Entity": {
    "Id": "ABC90712ABC",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}

Response Details

GetObjectsResponse
Result Properties
Entity EntityKey

The entity id and type.
Objects Dict<String, ObjectResult>

Requested objects that the calling entity has access to
ProfileVersion (required) int32

The current version of the profile, can be used for concurrency control during updates.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "ProfileVersion": 17,
    "Objects": {
      "gameState": {
        "ObjectName": "gameState",
        "EscapedDataObject": "{ \"Property\": { \"ValueName\": 5 } }"
      }
    },
    "Entity": {
      "Id": "ABC1234ABC",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    }
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code