Skip to main content
POST
Get Character Read Only Data

Authorizations

X-Authorization
string
header
required

This API requires a client session ticket, available from any Client Login function.

Body

application/json

Data is stored as JSON key-value pairs. If the Keys parameter is provided, the data object returned will only contain the data specific to the indicated Keys. Otherwise, the full set of custom character data will be returned.

Data is stored as JSON key-value pairs. If the Keys parameter is provided, the data object returned will only contain the data specific to the indicated Keys. Otherwise, the full set of custom character data will be returned.

CharacterId
string
required

Unique PlayFab assigned ID for a specific character owned by a user

IfChangedFromDataVersion
number

The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.

Keys
string[]

Specific keys to search for in the custom user data.

PlayFabId
string

Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026