Get Profiles
Retrieves the entity’s profile.
curl --request POST \
--url https://{titleId}.playfabapi.com/Profile/GetProfiles \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"Entities": [
{
"Id": "1234567787392",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
{
"Id": "42434567785265",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
]
}
'import requests
url = "https://{titleId}.playfabapi.com/Profile/GetProfiles"
payload = { "Entities": [
{
"Id": "1234567787392",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
{
"Id": "42434567785265",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
] }
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({
Entities: [
{
Id: '1234567787392',
Type: 'title_player_account',
TypeString: 'title_player_account'
},
{
Id: '42434567785265',
Type: 'title_player_account',
TypeString: 'title_player_account'
}
]
})
};
fetch('https://{titleId}.playfabapi.com/Profile/GetProfiles', 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/GetProfiles",
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([
'Entities' => [
[
'Id' => '1234567787392',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
],
[
'Id' => '42434567785265',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
]
]
]),
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/GetProfiles"
payload := strings.NewReader("{\n \"Entities\": [\n {\n \"Id\": \"1234567787392\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n {\n \"Id\": \"42434567785265\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\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/GetProfiles")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Entities\": [\n {\n \"Id\": \"1234567787392\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n {\n \"Id\": \"42434567785265\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Profile/GetProfiles")
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 \"Entities\": [\n {\n \"Id\": \"1234567787392\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n {\n \"Id\": \"42434567785265\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Profiles": [
{
"Entity": {
"Id": "1234567787392",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"EntityChain": "title_player_account!09839712/1289749013/19073097/1234567787392"
}
]
}
}{
"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 set of entity types and entity identifiers will retrieve all readable profiles properties for the caller. Profiles that the caller is not allowed to read will silently not be included in the results.
Given a set of entity types and entity identifiers will retrieve all readable profiles properties for the caller. Profiles that the caller is not allowed to read will silently not be included in the results.
Entity keys of the profiles to load. Must be between 1 and 25
Show child attributes
Show child attributes
Determines whether the entity statistics will be returned in the entity profile. Default is false.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON string.
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
{
"Profiles": [
{
"Entity": {
"Id": "1234567787392",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"EntityChain": "title_player_account!09839712/1289749013/19073097/1234567787392"
}
]
}
Was this page helpful?
curl --request POST \
--url https://{titleId}.playfabapi.com/Profile/GetProfiles \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"Entities": [
{
"Id": "1234567787392",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
{
"Id": "42434567785265",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
]
}
'import requests
url = "https://{titleId}.playfabapi.com/Profile/GetProfiles"
payload = { "Entities": [
{
"Id": "1234567787392",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
{
"Id": "42434567785265",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
] }
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({
Entities: [
{
Id: '1234567787392',
Type: 'title_player_account',
TypeString: 'title_player_account'
},
{
Id: '42434567785265',
Type: 'title_player_account',
TypeString: 'title_player_account'
}
]
})
};
fetch('https://{titleId}.playfabapi.com/Profile/GetProfiles', 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/GetProfiles",
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([
'Entities' => [
[
'Id' => '1234567787392',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
],
[
'Id' => '42434567785265',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
]
]
]),
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/GetProfiles"
payload := strings.NewReader("{\n \"Entities\": [\n {\n \"Id\": \"1234567787392\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n {\n \"Id\": \"42434567785265\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\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/GetProfiles")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Entities\": [\n {\n \"Id\": \"1234567787392\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n {\n \"Id\": \"42434567785265\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Profile/GetProfiles")
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 \"Entities\": [\n {\n \"Id\": \"1234567787392\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n {\n \"Id\": \"42434567785265\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"Profiles": [
{
"Entity": {
"Id": "1234567787392",
"Type": "title_player_account",
"TypeString": "title_player_account"
},
"EntityChain": "title_player_account!09839712/1289749013/19073097/1234567787392"
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}