Documentation

GetPlayFabIDsFromTwitchIDs

Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as "_id" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).

Request Details

GetPlayFabIDsFromTwitchIDsRequest
Request Properties
TwitchIds (required) List<String>

Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers.

POST https://{{TitleID}}.playfabapi.com/Client/GetPlayFabIDsFromTwitchIDs
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "TwitchIds": [
    "127168541",
    "88315720"
  ]
}
        

Response Details

For Twitch identifiers which have not been linked to PlayFab accounts, null will be returned.

GetPlayFabIDsFromTwitchIDsResult
Result Properties
Data List<TwitchPlayFabIdPair>

Mapping of Twitch identifiers to PlayFab identifiers.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Data": [
      {
        "TwitchId": "127168541",
        "PlayFabId": "5a446c83645201"
      },
      {
        "TwitchId": "88315720",
        "PlayFabId": "6345cd25a6c7cc"
      }
    ]
  }
}

Authentication

SessionTicket

Possible Error Codes

Name Code
AccountNotFound 1001