Get my lobby

Returns the full state of the lobby the caller is currently in. The caller is identified by x-player-id.

If the lobby is in in_queue status (matchmaking active), the response includes live matchmaking.queueStats with the number of players searching, lobbies in queue, and average wait time.

Use this to poll lobby state. For real-time updates, use GET /{config}/me/events (SSE) instead.

Returns 404 if the player is not currently in a lobby.

GET /api/v3/lobbies/{config}/me

Get my lobby

cURL

curl --request GET \
  --url https://api.computeflow.cloud/api/v3/lobbies/{config}/me \
  --header 'api-key: <api-key>' \
  --header 'x-player-id: <x-player-id>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "config": "<string>",
  "status": "waiting",
  "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>",
    "status": "launching",
    "network_ports": [
      {
        "name": "<string>",
        "internal_port": 123,
        "external_port": 123,
        "protocol": "udp",
        "host": "<string>",
        "tls_enabled": true
      }
    ],
    "startup_args": "<string>",
    "service_type": "match_based",
    "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>",
  "matchmakingError": "<string>"
}

Authorizations

api-key · string · header · required

Headers

x-player-id · string · required

Unique player identifier.

Path Parameters

config · string · required

Lobby configuration name or ID.

Response

200

application/json

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

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.

Show child attributes

players · object[] · required

Players in the lobby with their state.

Show child attributes

server · object | null · required

Game server info (null when no game running).

Show child attributes

matchmaking · object | null · required

Matchmaking info (null when not searching).

Show child attributes

createdAt · string · required

ISO 8601 creation timestamp.

updatedAt · string · required

ISO 8601 last update timestamp.

matchmakingError · string | null

Set when a queue entry was failed after repeated server-create failures. Explains why the match never formed; the lobby is returned to waiting so the player can retry.