Get Lobby
Get a lobby.
Allowed entity token types: title, game_server, title_player_account
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| LobbyBadRequest | 13007 |
| LobbyDoesNotExist | 13000 |
| LobbyRateLimitExceeded | 13001 |
POST
/
Lobby
/
GetLobby
Get Lobby
curl --request POST \
--url https://{titleId}.playfabapi.com/Lobby/GetLobby \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"LobbyId": "12345678-1234-1234-1234-123456789ABC"
}
'import requests
url = "https://{titleId}.playfabapi.com/Lobby/GetLobby"
payload = { "LobbyId": "12345678-1234-1234-1234-123456789ABC" }
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({LobbyId: '12345678-1234-1234-1234-123456789ABC'})
};
fetch('https://{titleId}.playfabapi.com/Lobby/GetLobby', 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/Lobby/GetLobby",
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([
'LobbyId' => '12345678-1234-1234-1234-123456789ABC'
]),
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/Lobby/GetLobby"
payload := strings.NewReader("{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\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/Lobby/GetLobby")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Lobby/GetLobby")
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 \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {
"Lobby": {
"AccessPolicy": "Public",
"ChangeNumber": 123,
"ConnectionString": "<string>",
"LobbyId": "<string>",
"MaxPlayers": 123,
"MembershipLock": "Unlocked",
"RestrictInvitesToLobbyOwner": true,
"UseConnections": true,
"LobbyData": {},
"Members": [
{
"MemberData": {},
"MemberEntity": {
"Id": "<string>",
"Type": "<string>"
},
"PubSubConnectionHandle": "<string>"
}
],
"Owner": {
"Id": "<string>",
"Type": "<string>"
},
"OwnerMigrationPolicy": "None",
"PubSubConnectionHandle": "<string>",
"SearchData": {},
"Server": {
"PubSubConnectionHandle": "<string>",
"ServerData": {},
"ServerEntity": {
"Id": "<string>",
"Type": "<string>"
}
}
}
}
}{
"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
application/json
Request to get a lobby.
Last modified on October 1, 2026
Was this page helpful?
⌘I
Get Lobby
curl --request POST \
--url https://{titleId}.playfabapi.com/Lobby/GetLobby \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"LobbyId": "12345678-1234-1234-1234-123456789ABC"
}
'import requests
url = "https://{titleId}.playfabapi.com/Lobby/GetLobby"
payload = { "LobbyId": "12345678-1234-1234-1234-123456789ABC" }
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({LobbyId: '12345678-1234-1234-1234-123456789ABC'})
};
fetch('https://{titleId}.playfabapi.com/Lobby/GetLobby', 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/Lobby/GetLobby",
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([
'LobbyId' => '12345678-1234-1234-1234-123456789ABC'
]),
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/Lobby/GetLobby"
payload := strings.NewReader("{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\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/Lobby/GetLobby")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Lobby/GetLobby")
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 \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {
"Lobby": {
"AccessPolicy": "Public",
"ChangeNumber": 123,
"ConnectionString": "<string>",
"LobbyId": "<string>",
"MaxPlayers": 123,
"MembershipLock": "Unlocked",
"RestrictInvitesToLobbyOwner": true,
"UseConnections": true,
"LobbyData": {},
"Members": [
{
"MemberData": {},
"MemberEntity": {
"Id": "<string>",
"Type": "<string>"
},
"PubSubConnectionHandle": "<string>"
}
],
"Owner": {
"Id": "<string>",
"Type": "<string>"
},
"OwnerMigrationPolicy": "None",
"PubSubConnectionHandle": "<string>",
"SearchData": {},
"Server": {
"PubSubConnectionHandle": "<string>",
"ServerData": {},
"ServerEntity": {
"Id": "<string>",
"Type": "<string>"
}
}
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}