DELETE
Cancel matchmaking

Authorizations

api-key
string
header
required

Per-project client key, prefixed ck_live_. Player-facing endpoints only, and browse never returns private lobbies. Safe to ship in a game binary: a leak exposes one project's player surface, nothing else.

Headers

x-player-id
string
required

Identifies the acting player. Trusted verbatim: Simpl performs no authentication or token verification on this value. Bring your own identity system and pass whatever stable id it produces.

Required string length: 1 - 128
Example:

"player_1"

Path Parameters

lobby_id
string
required

Lobby identifier.

Example:

"lobby_456"

Response

The lobby, back in waiting.

lobby_id
string
required
Example:

"lobby_456"

queue_id
string
required
Example:

"ranked_2v2"

status
enum<string>
required

Lobby lifecycle:

Available options:
waiting,
in_queue,
matched,
starting,
in_game
host_player_id
string
required
Example:

"player_1"

is_private
boolean
required

Private lobbies never appear in GET /v1/lobbies for client keys, and are joinable by invite code only.

max_players
integer
required
Required range: 1 <= x <= 100
Example:

4

current_players
integer
required
Required range: x >= 0
Example:

2

players
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string
Example:

"Austin's lobby"

region
enum<string>

Datacenter region a server runs in. 16 regions are supported.

Every region is available to every project. Capacity is Simpl's problem, not yours: pick the region closest to your players.

Available options:
ams,
arn,
bom,
cdg,
dfw,
ewr,
fra,
iad,
lax,
lhr,
nrt,
ord,
sin,
sjc,
syd,
yyz
Example:

"iad"

invite_code
string | null

Generated per the queue's invite_code_config. Null when the queue has invite codes disabled.

Example:

"SIMPL-K7Q2F1"

settings
object

Free-form, game-specific lobby settings: map, mode, difficulty, whatever the game needs. Host-writable via PATCH /v1/lobbies/{lobby_id}/settings.

Example:
server
object | null

Connection details for the game server backing this lobby. Present once the server is running. Connection-relevant fields only. Call GET /v1/servers/{instance_id} with a server key for the full object.

match_id
string | null
Example:

"xyz789"