Documentation

GetPlayerTags

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

Request Details

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.

GetPlayerTagsRequest
Request Properties
Namespace String

Optional namespace to filter results by

PlayFabId (required) String

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

POST https://{{TitleID}}.playfabapi.com/Server/GetPlayerTags
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "10931252888739651331",
  "Namespace": "title.AAA"
}
        

Response Details

GetPlayerTagsResult
Result Properties
PlayFabId (required) String

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

Tags (required) List<String>

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

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "PlayFabId": "10931252888739651331",
    "Tags": [
      "title.AAA.MostKilled",
      "title.AAA.MostPlayed",
      "title.AAA.MostBanned"
    ]
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
AccountNotFound 1001