GET
Browse lobbies

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

Optional player identity. When present the response may include player-specific fields. Trusted verbatim, never verified.

Required string length: 1 - 128
Example:

"player_1"

Query Parameters

queue_id
string
Example:

"ranked_2v2"

status
enum<string>

Filter by lobby status.

Available options:
waiting,
in_queue,
matched,
starting,
in_game
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"

limit
integer
default:50

Maximum number of items to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip before collecting the result set.

Required range: x >= 0
sort
enum<string>
default:created_at_desc

Result ordering.

Available options:
created_at_desc,
created_at_asc,
player_count_desc
include_private
boolean
default:false

Include private lobbies in the results. Server key only: client keys always get public results, whatever this is set to.

Response

A page of lobbies.

Envelope fields shared by every list endpoint.

total
integer
required

Total number of items matching the query, ignoring pagination.

Example:

100

limit
integer
required
Example:

50

offset
integer
required
Example:

0

has_more
boolean
required

Whether more items exist past offset + limit.

Example:

true

data
object[]
required