Rivet

lobbies.getState

Description

Get the state of any lobby.

This endpoint requires a lobby token for authentication, or a development namespace token for mock responses. When running on Rivet servers, you can access the given lobby token from the RIVET_TOKEN environment variable.

Code Examples

Request

GET
https://api.rivet.gg/matchmaker/lobbies/{lobby_id}/state
curl -X GET 'https://api.rivet.gg/matchmaker/lobbies/{lobby_id}/state'

Request Parameters

lobby_id

Path parameter, required

Response Body

lobbies.setState
players.getStatistics

Was this page helpful?

Edit Page

On this page

Rivet

Open-source multiplayer infrastructure. Easy, flexible, and affordable.

DiscordTwitterGitHubYouTubeLinkedIn
Legal
This website is not sponsored by or affiliated with Unity Technologies or its affiliates. Unity Trademark(s) are trademark(s) or registered trademark(s) of Unity Technologies or its affiliates in the U.S. and elsewhere. | This website is not sponsored by, affiliated with, or endorsed by Epic Games, Inc. or its affiliates. 'Unreal Engine' is a trademark or registered trademark of Epic Games, Inc. in the U.S. and elsewhere. | The HTML5 Logo by the World Wide Web Consortium (W3C), used under a Creative Commons Attribution 3.0 License. Source | The Godot Engine Logo by the Andrea Calabró, used under a Creative Commons Attribution 4.0 International License. Source | Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries. Docker, Inc. and other parties may also have trademark rights in other terms used herein.

© 2024 Rivet Gaming, Inc. All rights reserved.