Play Stream - Get Player Tags

Get all tags with a given Namespace (optional) from a player profile.

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

Request Header

Name Required Type Description
X-Authorization True
  • string

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

Request Body

Name Required Type Description
PlayFabId True
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

CustomTags
  • object

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

Namespace
  • string

Optional namespace to filter results by

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

X-Authorization

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

GetPlayerTagsRequest

This API will return a list of canonical tags which includes both namespace and tag's name. If namespace is not provided, the result is a list of all canonical tags. TagName can be used for segmentation and Namespace is limited to 128 characters.

GetPlayerTagsResult

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

GetPlayerTagsRequest

This API will return a list of canonical tags which includes both namespace and tag's name. If namespace is not provided, the result is a list of all canonical tags. TagName can be used for segmentation and Namespace is limited to 128 characters.

Name Type Description
CustomTags
  • object

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

Namespace
  • string

Optional namespace to filter results by

PlayFabId
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

GetPlayerTagsResult

Name Type Description
PlayFabId
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Tags
  • string[]

Canonical tags (including namespace and tag's name) for the requested user