Skip to main content
GET
/
v1
/
lobbies
cURL
curl --request GET \
  --url https://api.adventure-builder.net/v1/lobbies
[
  {
    "id": 123,
    "creatorId": 123,
    "players": [
      123
    ],
    "maxPlayers": 3,
    "locked": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "serverCode": "<string>"
  }
]
Lobbies are highly dynamic and may change or disappear within moments.

Query Parameters

​
maxPlayers
integer

Filter lobbies by maximum player count.

Required range: 2 <= x <= 5
​
type
enum<string>

Filter lobbies by type.

Available options:
public,
friends
​
player
integer<int64>

Filter lobbies containing specific player ID.

Response

List of all matching lobbies

​
id
integer<int32>
required

The unique ID of the lobby.

​
creatorId
integer<int32>
required

The ID of the player who created the lobby.

​
players
integer<int32>[]
required

Array of player IDs currently in the lobby.

​
type
enum<string>

The type of lobby.

Available options:
public,
friends
​
maxPlayers
integer

Maximum number of players allowed in the lobby.

Required range: 2 <= x <= 5
​
locked
boolean

Whether the lobby is locked (in game).

​
createdAt
string<date-time>

The timestamp when the lobby was created.

​
serverCode
string

The server code where the lobby is located (only visible with auth).