Breakroom offers several APIs designed to help you manage users and regions within your world (here referred to as a grid). Learn how to add users, delete users, update regions, and more.
These APIs require specific access to be granted to your account. If you have purchased your own grid, this will be automatically enabled on the primary user account.
You may send parameters as either POST form_data, or as Query parameters on the URL.
All APIs require you send three additional POST parameters:adminname, adminpwd,and gridid.These should be the username and password of an account on the grid with administrator rights, along with the grid with which you intend to interface. We recommend creating a new user for this role specifically.