Player Data Management - Get User Data

Retrieves the title-specific custom data for the user which is readable and writable by the client

POST https://titleId.playfabapi.com/Client/GetUserData

Request Body

Name Type Description
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[]

List of unique keys to load from.

PlayFabId
  • string

Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. When specified to a PlayFab id of another player, then this will only return public keys for that account.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer-wrapper for all responses with errors

Security

SessionTicket

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

GetUserDataRequest

Data is stored as JSON key-value pairs. Every time the data is updated via any source, the version counter is incremented. If the Version parameter is provided, then this call will only return data if the current version on the system is greater than the value provided. 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 user data will be returned.

GetUserDataResult
UserDataPermission

Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.

UserDataRecord

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

Numerical Playfab error code

errorDetails
  • object

Detailed description of individual issues with the request object

errorMessage
  • string

Description for the Playfab errorCode

status
  • string

String HTTP code

GetUserDataRequest

Data is stored as JSON key-value pairs. Every time the data is updated via any source, the version counter is incremented. If the Version parameter is provided, then this call will only return data if the current version on the system is greater than the value provided. 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 user data will be returned.

Name Type Description
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[]

List of unique keys to load from.

PlayFabId
  • string

Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. When specified to a PlayFab id of another player, then this will only return public keys for that account.

GetUserDataResult

Name Type Description
Data

User specific data for this title.

DataVersion
  • number

Indicates the current version of the data that has been set. This is incremented with every set call for that type of data (read-only, internal, etc). This version can be provided in Get calls to find updated data.

UserDataPermission

Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.

Name Type Description
Private
  • string
Public
  • string

UserDataRecord

Name Type Description
LastUpdated
  • string

Timestamp for when this data was last updated.

Permission

Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData requests being made by one player about another player.

Value
  • string

Data stored for the specified user data key.