Get Friends List

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/GetFriendsList \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "ExternalPlatformFriends": "Steam"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/GetFriendsList"

payload = { "ExternalPlatformFriends": "Steam" }
headers = {
    "X-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ExternalPlatformFriends: 'Steam'})
};

fetch('https://{titleId}.playfabapi.com/Client/GetFriendsList', 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/Client/GetFriendsList",
  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([
    'ExternalPlatformFriends' => 'Steam'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Authorization: <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/Client/GetFriendsList"

	payload := strings.NewReader("{\n  \"ExternalPlatformFriends\": \"Steam\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Authorization", "<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/Client/GetFriendsList")
  .header("X-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ExternalPlatformFriends\": \"Steam\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/GetFriendsList")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ExternalPlatformFriends\": \"Steam\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "Friends": [
      {
        "FriendPlayFabId": "93798903892789754w",
        "Username": "accountName",
        "TitleDisplayName": "Davros01",
        "Tags": [
          "single blue eye",
          "genius with robotics"
        ],
        "CurrentMatchmakerLobbyId": "2073",
        "Profile": {
          "AvatarUrl": "https://example.org/profile1.jpg",
          "Statistics": [
            {
              "Name": "Points",
              "Version": 2,
              "Value": 7
            },
            {
              "Name": "Points",
              "Version": 1,
              "Value": 40
            },
            {
              "Name": "XP",
              "Version": 1,
              "Value": 10
            }
          ]
        }
      },
      {
        "FriendPlayFabId": "334907923945f",
        "Username": "accountName",
        "TitleDisplayName": "CyberLeader1",
        "Tags": [
          "allergic to gold",
          "upgradeable"
        ],
        "CurrentMatchmakerLobbyId": "2073",
        "Profile": {
          "AvatarUrl": "https://example.org/profile2.jpg",
          "Statistics": [
            {
              "Name": "Points",
              "Version": 2,
              "Value": 15
            },
            {
              "Name": "XP",
              "Version": 1,
              "Value": 5
            }
          ]
        }
      }
    ]
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}