Sign in
latestOpenAPI 3.0.42026-08-208311,1873.2 MB

958b2b40425d

Places

Gets the place configuration for the place with the id placeId

get/v2/places/{placeId}

Path parameters

placeIdinteger required

The place id for the place to be updated.

Response

OK

maxPlayerCountinteger

The max number of players for the place.

socialSlotTypestring

The social slot type for the place. Determines how users are placed into servers. Examples: Automatic, Empty, Custom

customSocialSlotsCountinteger

The number of social slots for the place when the slot type is custom.

allowCopyingboolean

Determines if copying of the place is allowed.

currentSavedVersioninteger

The current saved version number of the place.

isAllGenresAllowedboolean

Whether all genres allowed in the place.

allowedGearTypesinteger[]

Types of Roblox gear that are allowed to exist in the place. Valid values are from amp::AssetCategory

maxPlayersAllowedinteger

The maximum allowed number of players for the place that the user can set, based on user roleset.

createdstring date-time

The time place was created.

updatedstring date-time

The time place was updated.

idinteger

Returns the place id.

universeIdinteger

Returns the id of the place's universe, or null - if the place is not part of a universe.

namestring

Returns the place name.

descriptionstring

Returns the place description.

isRootPlaceboolean

Returns whether this place is the root place.