Account Management - Get PlayFab IDs From Facebook IDs

Service:

Server

API Version:

240412

Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.

POST https://titleId.playfabapi.com/Server/GetPlayFabIDsFromFacebookIDs

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
FacebookIDs	True	string[]	Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

Responses

Name	Type	Description
200 OK	GetPlayFabIDsFromFacebookIDsResult	For Facebook 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-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
FacebookPlayFabIdPair
GetPlayFabIDsFromFacebookIDsRequest
GetPlayFabIDsFromFacebookIDsResult	For Facebook identifiers which have not been linked to PlayFab accounts, null will be returned.

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

FacebookPlayFabIdPair

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

GetPlayFabIDsFromFacebookIDsRequest

Name	Type	Description
FacebookIDs	string[]	Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.

GetPlayFabIDsFromFacebookIDsResult

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

Name	Type	Description
Data	FacebookPlayFabIdPair[]	Mapping of Facebook identifiers to PlayFab identifiers.