Skip to main content
GET
/
api
/
v3
/
lobbies
/
{config}
/
{id}
Get lobby by ID
curl --request GET \
  --url https://api.computeflow.cloud/api/v3/lobbies/{config}/{id} \
  --header 'api-key: <api-key>'
import requests

url = "https://api.computeflow.cloud/api/v3/lobbies/{config}/{id}"

headers = {"api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

fetch('https://api.computeflow.cloud/api/v3/lobbies/{config}/{id}', 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://api.computeflow.cloud/api/v3/lobbies/{config}/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <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"
"net/http"
"io"
)

func main() {

url := "https://api.computeflow.cloud/api/v3/lobbies/{config}/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.computeflow.cloud/api/v3/lobbies/{config}/{id}")
.header("api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.computeflow.cloud/api/v3/lobbies/{config}/{id}")

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

request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "config": "<string>",
  "host": "<string>",
  "maxPlayers": 123,
  "currentPlayers": 123,
  "region": "<string>",
  "isPrivate": true,
  "allowLateJoin": true,
  "settings": {},
  "players": [
    {
      "id": "<string>",
      "state": {},
      "isHost": true
    }
  ],
  "server": {
    "instance_id": "<string>",
    "name": "<string>",
    "network_ports": [
      {
        "name": "<string>",
        "internal_port": 123,
        "external_port": 123,
        "host": "<string>",
        "tls_enabled": true
      }
    ],
    "startup_args": "<string>",
    "compute_size": "<string>",
    "region": "<string>",
    "version_tag": "<string>",
    "version": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "stopped_at": "2023-11-07T05:31:56Z",
    "auto_restart": true,
    "custom_data": {},
    "ttl": 123,
    "is_pool_server": true,
    "pool_claimed_at": "2023-11-07T05:31:56Z",
    "match_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "matchmaking": {
    "mode": "<string>",
    "startedAt": "<string>",
    "queueStats": {
      "playersSearching": 123,
      "lobbiesInQueue": 123,
      "avgWaitSeconds": 123
    },
    "confirmation": {
      "deadline": "<string>",
      "confirmed": true
    }
  },
  "createdAt": "<string>",
  "updatedAt": "<string>"
}
{
"error": "<string>",
"status": 123,
"detail": "<string>"
}

Authorizations

api-key
string
header
required

Path Parameters

config
string
required

Lobby configuration name or ID.

id
string<uuid>
required

Lobby ID (UUID).

Response

Full lobby state.

Full lobby state including players, server, and matchmaking info.

id
string<uuid>
required

Lobby ID.

code
string | null
required

Invite code for joining (null if private mode is disabled).

config
string
required

Lobby config name.

status
enum<string>
required

Current lobby status.

Available options:
waiting,
in_queue,
starting,
matched,
match_found,
in_game
host
string
required

Player ID of the host.

maxPlayers
number
required

Maximum player capacity.

currentPlayers
number
required

Current number of players.

region
string | null
required

Preferred game server region.

isPrivate
boolean
required

Whether the lobby is hidden from browsing.

allowLateJoin
boolean
required

Whether players can join mid-game.

settings
object
required

Custom game settings.

players
object[]
required

Players in the lobby with their state.

server
object | null
required

Game server info (null when no game running).

matchmaking
object | null
required

Matchmaking info (null when not searching).

createdAt
string
required

ISO 8601 creation timestamp.

updatedAt
string
required

ISO 8601 last update timestamp.