Account Management - Get PlayFab IDs From Twitch IDs

Service:

Client

API Version:

241122

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).

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

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
TwitchIds	True	string[]	Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

Responses

Name	Type	Description
200 OK	GetPlayFabIDsFromTwitchIDsResult	For Twitch identifiers which have not been linked to PlayFab accounts, null will be returned.
400 Bad Request	ApiErrorWrapper	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

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
GetPlayFabIDsFromTwitchIDsRequest
GetPlayFabIDsFromTwitchIDsResult	For Twitch identifiers which have not been linked to PlayFab accounts, null will be returned.
TwitchPlayFabIdPair

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

GetPlayFabIDsFromTwitchIDsRequest

Name	Type	Description
TwitchIds	string[]	Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

GetPlayFabIDsFromTwitchIDsResult

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

Name	Type	Description
Data	TwitchPlayFabIdPair[]	Mapping of Twitch identifiers to PlayFab identifiers.

TwitchPlayFabIdPair

Name	Type	Description
PlayFabId	string	Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Twitch identifier.
TwitchId	string	Unique Twitch identifier for a user.