Places
Universes

Get Place

Gets the specified place.

get/cloud/v2/universes/{universeId}/places/{placeId}

Request

  • Base URL
    https://apis.roblox.com
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://apis.roblox.com/oauth/v1/authorize
      Token URLhttps://apis.roblox.com/oauth/v1/token

Path parameters

universeIdstring required

The universe ID.

placeIdstring required

The place ID.

Response

OK

pathstring

The resource path of the place.

Format: universes/{universe_id}/places/{place_id}

createTimestring date-time

The timestamp at which the place was created.

updateTimestring date-time

The timestamp at which the place was updated.

displayNamestring

The name of the place.

descriptionstring

The description of the place.

serverSizeinteger

The maximum number of allowed users in a single server.

rootboolean

Whether this place is its parent universe's root place or not. Each universe has exactly one root place.

universeRuntimeCreationboolean

Whether this place was created through in-experience creation. If true, the place was created by calling AssetService::CreatePlaceAsync() from a script.

templatePlacestring required

The resource path of the template place used to initialize the place on creation. The newly created place will be a clone of this template. A list of the valid template places can be obtained from ListTemplatePlaces. Format: universes/{universe_id}/places/{place_id}

Changes

No recorded changes to this operation across all 36 revisions of this API.