Account Management - Get Profile

Retrieves the entity's profile.

POST https://titleId.playfabapi.com/Profile/GetProfile

Request Header

Name Required Type Description
X-EntityToken True

string

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

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 optional entity to perform this action on. Defaults to the currently logged in entity.

Responses

Name Type Description
200 OK

GetEntityProfileResponse

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

EffectType
EntityDataObject

An entity object and its associated meta data.

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

EntityLineage
EntityPermissionStatement
EntityProfileBody
EntityProfileFileMetadata

An entity file's meta data. To get a download URL call File/GetFiles API.

EntityStatisticValue
GetEntityProfileRequest

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.

GetEntityProfileResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code

error

string

Playfab error code

errorCode

integer

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

EffectType

Name Type Description
Allow

string

Deny

string

EntityDataObject

An entity object and its associated meta data.

Name Type Description
DataObject

object

Un-escaped JSON object, if DataAsObject is true.

EscapedDataObject

string

Escaped string JSON body of the object, if DataAsObject is default or false.

ObjectName

string

Name of this object.

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name Type Description
Id

string

Unique ID of the entity.

Type

string

Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

EntityLineage

Name Type Description
CharacterId

string

The Character Id of the associated entity.

GroupId

string

The Group Id of the associated entity.

MasterPlayerAccountId

string

The Master Player Account Id of the associated entity.

NamespaceId

string

The Namespace Id of the associated entity.

TitleId

string

The Title Id of the associated entity.

TitlePlayerAccountId

string

The Title Player Account Id of the associated entity.

EntityPermissionStatement

Name Type Description
Action

string

The action this statement effects. May be 'Read', 'Write' or '*' for both read and write.

Comment

string

A comment about the statement. Intended solely for bookkeeping and debugging.

Condition

object

Additional conditions to be applied for entity resources.

Effect

EffectType

The effect this statement will have. It may be either Allow or Deny

Principal

object

The principal this statement will effect.

Resource

string

The resource this statements effects. Similar to 'pfrn:data--title![Title ID]/Profile/*'

EntityProfileBody

Name Type Description
AvatarUrl

string

Avatar URL for the entity.

Created

string

The creation time of this profile in UTC.

DisplayName

string

The display name of the entity. This field may serve different purposes for different entity types. i.e.: for a title player account it could represent the display name of the player, whereas on a character it could be character's name.

Entity

EntityKey

The entity id and type.

EntityChain

string

The chain of responsibility for this entity. Use Lineage.

ExperimentVariants

string[]

The experiment variants of this profile.

Files

EntityProfileFileMetadata

The files on this profile.

Language

string

The language on this profile.

Lineage

EntityLineage

The lineage of this profile.

Objects

EntityDataObject

The objects on this profile.

Permissions

EntityPermissionStatement[]

The permissions that govern access to this entity profile and its properties. Only includes permissions set on this profile, not global statements from titles and namespaces.

Statistics

EntityStatisticValue

The statistics on this profile.

VersionNumber

number

The version number of the profile in persistent storage at the time of the read. Used for optional optimistic concurrency during update.

EntityProfileFileMetadata

An entity file's meta data. To get a download URL call File/GetFiles API.

Name Type Description
Checksum

string

Checksum value for the file, can be used to check if the file on the server has changed.

FileName

string

Name of the file

LastModified

string

Last UTC time the file was modified

Size

number

Storage service's reported byte count

EntityStatisticValue

Name Type Description
Metadata

string

Metadata associated with the Statistic.

Name

string

Statistic name

Scores

string[]

Statistic scores

Version

number

Statistic version

GetEntityProfileRequest

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.

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

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 optional entity to perform this action on. Defaults to the currently logged in entity.

GetEntityProfileResponse

Name Type Description
Profile

EntityProfileBody

Entity profile