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.
POST https://sine.space/worldapi/externalapi/add_user
This endpoint allows you to register new users automatically.
| Name | Type | Description |
|---|---|---|
POST https://sine.space/worldapi/externalapi/delete_user
Deletes or disables a user account.
POST https://sine.space/worldapi/externalapi/update_user
Changes information about a user account.
POST https://sine.space/worldapi/externalapi/get_users
Returns a bulk list of users associated with the grid.
POST https://sine.space/worldapi/externalapi/get_user_by_email
Retrieves information about an individual user via their email address
POST https://sine.space/worldapi/externalapi/update_login_region
Updates the user, and sets their login scene to the specified ID.
POST https://sine.space/worldapi/externalapi/create_region
Creates a new region on the grid.
POST https://sine.space/worldapi/externalapi/set_region_role
Sets or changes a user's role within a particular region.
POST https://sine.space/worldapi/externalapi/get_regions
Requests a list of regions on the grid.
POST https://sine.space/worldapi/externalapi/update_region
Updates information about a particular region.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
gridid
integer
The unique grid ID where the user will be registered.
password
string
The user's initial password.
string
The user's e-mail address. We will not send any messages to this address unless requested by the user (e.g. password reset).
username
string
The desired username. If a particular username is already taken, an interation on the provided name will be assigned to the account (e.g. "User Name01").
playeroutfitid
integer
The "Outfit ID" the user should be wearing when they first log in. As this creates "free" copies of items that may be listed as paid items on our Marketplace, the creator of the items must be an administrator of the grid in question.
userid
integer
The user ID associated with the user account.
userid
integer
The user ID associated with the user account.
string
Updates the user's e-mail address.
password
string
Updates the user's password.
userids
string
A comma separated list of user IDs you are interested in returning information about.
offset
integer
The query will return a maximum of 100 records. If more are available, use "offset" to return past this point.
string
The e-mail address associated with the account.
userid
integer
The particular user whose login scene you want to update.
regionid
integer
The scene you want to set as the user's login scene. Set to zero to return to grid default.
owner
integer
The user ID to be marked as owner of the region.
templateid
integer
The item ID for the region template to use.
accesslevel
integer
Either "0" for no access, "1" for free-for-all access, "2" for friends-only access, and "3" for approved only access.
regionname
string
The name of the region you wish to create.
regionid
integer
The ID of the region.
userid
integer
The ID of the user in question.
role
string
Either "Normal," "Admin," or "Blocked."
offset
integer
Offsets the results if there are too many to return in a single query.
owner
integer
Return regions owned by a particular owner's account.
regionids
string
A CSV list of region IDs to return information about.
regionid
integer
The region ID to update information about.
regionname
string
If present, changes the name of the region.
templateid
integer
If present, changes the template of the region to the specified template ID.
accesslevel
integer
Either "0" - no access, "1" - free access, "2" - friends-only access, and "3" - approved only access.