Documentation

GetTitleData

Retrieves the key-value store of custom title settings

Request Details

This API is designed to return title specific values which can be read, but not written to, by the client. For example, a developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths, movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new build. Note that there may up to a minute delay in between updating title data and this API call returning the newest value.

GetTitleDataRequest
Request Properties
Keys List<String>

Specific keys to search for in the title data (leave null to get all keys)

POST https://{{TitleID}}.playfabapi.com/Server/GetTitleData
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "Keys": [
    "color",
    "propertyA"
  ]
}
        

Response Details

GetTitleDataResult
Result Properties
Data Dict<String, String>

a dictionary object of key / value pairs

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Data": {
      "color": "blue",
      "propertyA": "xyz123"
    }
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code