Get Title Players From Xbox Live I Ds
Retrieves the title player accounts associated with the given XUIDs.
curl --request POST \
--url https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"XboxLiveIds": [
"1233455677"
],
"Sandbox": "RETAIL"
}
'import requests
url = "https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs"
payload = {
"XboxLiveIds": ["1233455677"],
"Sandbox": "RETAIL"
}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({XboxLiveIds: ['1233455677'], Sandbox: 'RETAIL'})
};
fetch('https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'XboxLiveIds' => [
'1233455677'
],
'Sandbox' => 'RETAIL'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs"
payload := strings.NewReader("{\n \"XboxLiveIds\": [\n \"1233455677\"\n ],\n \"Sandbox\": \"RETAIL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"XboxLiveIds\": [\n \"1233455677\"\n ],\n \"Sandbox\": \"RETAIL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"XboxLiveIds\": [\n \"1233455677\"\n ],\n \"Sandbox\": \"RETAIL\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"TitlePlayerAccounts": {
"1233455677": {
"NamespaceId": "9528716980912",
"TitleId": "12342",
"MasterPlayerAccountId": "23458716980912",
"TitlePlayerAccountId": "81258716980352"
}
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
Given a collection of Xbox IDs (XUIDs), returns all title player accounts.
Given a collection of Xbox IDs (XUIDs), returns all title player accounts.
Xbox Sandbox the players had on their Xbox tokens.
List of Xbox Live XUIDs
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Optional ID of title to get players from, required if calling using a master_player_account.
Response
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Show child attributes
Show child attributes
{
"TitlePlayerAccounts": {
"1233455677": {
"NamespaceId": "9528716980912",
"TitleId": "12342",
"MasterPlayerAccountId": "23458716980912",
"TitlePlayerAccountId": "81258716980352"
}
}
}
Was this page helpful?
curl --request POST \
--url https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"XboxLiveIds": [
"1233455677"
],
"Sandbox": "RETAIL"
}
'import requests
url = "https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs"
payload = {
"XboxLiveIds": ["1233455677"],
"Sandbox": "RETAIL"
}
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({XboxLiveIds: ['1233455677'], Sandbox: 'RETAIL'})
};
fetch('https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'XboxLiveIds' => [
'1233455677'
],
'Sandbox' => 'RETAIL'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs"
payload := strings.NewReader("{\n \"XboxLiveIds\": [\n \"1233455677\"\n ],\n \"Sandbox\": \"RETAIL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"XboxLiveIds\": [\n \"1233455677\"\n ],\n \"Sandbox\": \"RETAIL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"XboxLiveIds\": [\n \"1233455677\"\n ],\n \"Sandbox\": \"RETAIL\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"TitlePlayerAccounts": {
"1233455677": {
"NamespaceId": "9528716980912",
"TitleId": "12342",
"MasterPlayerAccountId": "23458716980912",
"TitlePlayerAccountId": "81258716980352"
}
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}