> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adventure-builder.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Get lobby-list

> Returns a list of all available lobbies with optional filters.

<Warning>Lobbies are highly dynamic and may change or disappear within moments.</Warning>


## OpenAPI

````yaml GET /v1/lobbies
openapi: 3.0.1
info:
  title: Adventure Builder API
  description: >-
    An API for retrieving levels, leaderboards, assets, and managing multiplayer
    lobbies in the Adventure Builder game.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.adventure-builder.net
security: []
paths:
  /v1/lobbies:
    get:
      description: Returns a list of all available lobbies with optional filters.
      parameters:
        - name: maxPlayers
          in: query
          description: Filter lobbies by maximum player count.
          required: false
          schema:
            type: integer
            minimum: 2
            maximum: 5
        - name: type
          in: query
          description: Filter lobbies by type.
          required: false
          schema:
            type: string
            enum:
              - public
              - friends
        - name: player
          in: query
          description: Filter lobbies containing specific player ID.
          required: false
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: List of all matching lobbies
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Lobby'
        '400':
          description: Invalid filter parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Lobby:
      type: object
      required:
        - id
        - creatorId
        - players
      properties:
        id:
          description: The unique ID of the lobby.
          type: integer
          format: int32
        creatorId:
          description: The ID of the player who created the lobby.
          type: integer
          format: int32
        type:
          description: The type of lobby.
          type: string
          enum:
            - public
            - friends
        maxPlayers:
          description: Maximum number of players allowed in the lobby.
          type: integer
          minimum: 2
          maximum: 5
        players:
          description: Array of player IDs currently in the lobby.
          type: array
          items:
            type: integer
            format: int32
        locked:
          description: Whether the lobby is locked (in game).
          type: boolean
        createdAt:
          description: The timestamp when the lobby was created.
          type: string
          format: date-time
        serverCode:
          description: The server code where the lobby is located (only visible with auth).
          type: string
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
          description: Error message

````