> ## Documentation Index > Fetch the complete documentation index at: https://docs.playflowcloud.com/llms.txt > Use this file to discover all available pages before exploring further. # Browse lobbies > Returns a paginated list of public lobbies for the given config. Private lobbies are excluded. Use `status` to filter by lobby state (`waiting`, `in_queue`, `in_game`). Use `region` to filter by region. **No x-player-id required.** This endpoint is designed for lobby browsers and server-side matchmaking systems. Results are ordered by creation time (newest first). ## OpenAPI ````yaml https://api.computeflow.cloud/api/doc get /api/v3/lobbies/{config} openapi: 3.1.0 info: title: PlayFlow API version: 3.0.0 description: > PlayFlow is a game server hosting and orchestration platform. Deploy, manage, and scale multiplayer game servers globally with built-in matchmaking, lobby management, and billing. ## Authentication All API endpoints (except Health) require the `api-key` header: ``` api-key: pf_your_project_api_key ``` Find your API key in the PlayFlow dashboard under **Project Settings**. Each project has a server key (`pf_...`) for privileged operations and a client key (`pfclient_...`) for game client integrations. Both work in the `api-key` header. ## Quick Start 1. **Upload a build**: `POST /v3/builds/upload-url` → get presigned URL → `PUT` your ZIP → processing starts automatically 2. **Start a server**: `POST /v3/servers/start` → get connection info in `network_ports` 3. **Connect your game client**: Use `host:external_port` from the response ## Key Concepts - **Builds**: Your game server binary packaged as a ZIP or Docker image. Versioned per name per project. - **Servers**: Running game server instances. Each gets dedicated compute and network ports with automatic health monitoring. - **Pool Servers**: Pre-provisioned servers for instant startup (~5s vs ~30s cold start). - **Regions**: 12 global regions (us-east, us-west, eu-north, eu-west, eu-uk, ap-south, sea, ap-north, ap-southeast, south-africa, south-america-brazil, south-america-chile). - **Compute Sizes**: From micro (512MB) to dedicated-xlarge (16GB dedicated CPU). ## Server Lifecycle `launching` → `running` (game ports open) → `stopped` (game exits, TTL expires, or manual stop) ## Build Lifecycle `uploading` → `processing` (build pipeline creates deployable image) → `ready` | `failed` ## Rate Limits - General reads: 100 req/sec per API key - Write operations (start server, upload build): 10 req/sec per API key - Headers: `X-RateLimit-Limit`, `X-RateLimit-Remaining` ## Plan Limits - **Free**: 1 server max, forced 1hr TTL, small size only - **Pro**: Unlimited servers, all sizes, custom TTL, pool servers ## Error Format All errors return: `{ "error": "message", "detail": "context", "status": 404 }` servers: - url: https://api.computeflow.cloud security: - ApiKeyAuth: [] tags: - name: Servers description: >- Create, manage, and monitor game server instances. Each server gets dedicated compute, network ports, and automatic health monitoring with TTL enforcement. Servers start in `launching` status and transition to `running` when the game opens its ports. - name: Builds description: >- Upload and manage game server builds. Supports ZIP uploads (automatically processed into deployable images) and direct Docker image references. Builds are versioned per name per project — uploading a new build with the same name auto-increments the version. Servers always use the latest `ready` build unless a specific version is pinned. - name: Projects description: >- Configure project-level settings including network ports, player authentication, environment variables, server pooling, and lobby/matchmaking rules. Settings apply as defaults to all servers in the project and can be overridden per-server at start time. - name: Lobbies description: >- Player-centric lobby and matchmaking system. Every request identifies the player via the `x-player-id` header. Use `/me` endpoints to interact with your current lobby — the API resolves which lobby you're in automatically. **Quick start:** `POST /v3/lobbies/default` creates a lobby with sensible defaults (no dashboard config needed). Share the invite `code` with friends, or use `POST /v3/lobbies/default/me/matchmaking` to find opponents automatically. **Matchmaking** supports symmetric teams (2v2, 5v5), asymmetric roles (1 monster vs 5 hunters), FFA, battle royale duos, and skill-based matching with auto-expanding MMR buckets. paths: /api/v3/lobbies/{config}: get: tags: - Lobbies summary: Browse lobbies description: >- Returns a paginated list of public lobbies for the given config. Private lobbies are excluded. Use `status` to filter by lobby state (`waiting`, `in_queue`, `in_game`). Use `region` to filter by region. **No x-player-id required.** This endpoint is designed for lobby browsers and server-side matchmaking systems. Results are ordered by creation time (newest first). operationId: browseLobbies parameters: - schema: type: string description: Lobby configuration name or ID. required: true description: Lobby configuration name or ID. name: config in: path - schema: type: string description: Filter by region. required: false description: Filter by region. name: region in: query - schema: type: string description: Filter by status (waiting, in_queue, in_game). required: false description: Filter by status (waiting, in_queue, in_game). name: status in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: Max results per page (1–100). Defaults to 50. required: false description: Max results per page (1–100). Defaults to 50. name: limit in: query - schema: type: - integer - 'null' minimum: 0 default: 0 description: Pagination offset. Defaults to 0. required: false description: Pagination offset. Defaults to 0. name: offset in: query responses: '200': description: Paginated list of public lobbies matching the filters. content: application/json: schema: type: object properties: lobbies: type: array items: type: object properties: id: type: string format: uuid description: Lobby ID. config: type: string description: Lobby config name. name: type: string description: Display name. status: type: string enum: - waiting - in_queue - starting - matched - match_found - in_game description: Current lobby status. host: type: string description: Player ID of the host. maxPlayers: type: number description: Maximum player capacity. currentPlayers: type: number description: Current number of players. region: type: - string - 'null' description: Preferred game server region. allowLateJoin: type: boolean description: Whether players can join mid-game. hasServer: type: boolean description: >- True if a game server is associated with this lobby. Use `GET /{config}/me` for details. createdAt: type: string description: ISO 8601 creation timestamp. updatedAt: type: string description: ISO 8601 last update timestamp. required: - id - config - name - status - host - maxPlayers - currentPlayers - region - allowLateJoin - hasServer - createdAt - updatedAt description: >- Summary shape for lobby browse. Join a lobby to see full state. description: Lobbies matching the query. total: type: number description: Total matching lobbies. limit: type: number description: Page size. offset: type: number description: Page offset. hasMore: type: boolean description: True if more results exist beyond this page. required: - lobbies - total - limit - offset - hasMore description: Paginated list of public lobbies (summary projection). components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: api-key ````