ROroblox
Universes

Get Universe

Gets the specified universe.

get/cloud/v2/universes/{universeId}

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.

Response

OK

pathstring

The resource path of the universe.

Format: universes/{universe_id}

createTimestring date-time

The timestamp when the universe was created.

updateTimestring date-time

The timestamp when the universe was last updated.

displayNamestring

The name of the universe.

This field can be updated by updating the root place's name.

descriptionstring

The description of the universe.

This field can be updated by updating the root place's description.

userstring

The universe is user-owned.

groupstring

The universe is group-owned.

visibility'VISIBILITY_UNSPECIFIED' | 'PUBLIC' | 'PRIVATE'

Represents whether or not the Universe is publicly accessible.

voiceChatEnabledboolean

Whether or not voice chat is enabled for users in the Experience.

Updating this value will not affect active servers.

ageRating'AGE_RATING_UNSPECIFIED' | 'AGE_RATING_ALL' | 'AGE_RATING_9_PLUS' | 'AGE_RATING_13_PLUS' | 'AGE_RATING_17_PLUS'

Supported age ratings for the universe. This field is read only.

privateServerPriceRobuxinteger

Represents the price in Robux of private servers.

If unset, private servers are not supported for this universe.

Can only be disabled when using a field mask.

Setting to null will disable all active private servers.

Changing the price will cancel all private server subscriptions.

desktopEnabledboolean

Whether or not players can join the Experience via Desktop.

mobileEnabledboolean

Whether or not players can join the Experience via Mobile.

tabletEnabledboolean

Whether or not players can join the Experience via Tablet.

consoleEnabledboolean

Whether or not players can join the Experience via Console.

vrEnabledboolean

Whether or not players can join the Experience via VR.

rootPlacestring

The resource path of the root place of this universe Format: universes/{universe_id}/places/{place_id}

templateRootPlacestring required

The resource path of the template place, used for CreateUniverse. The root place of the newly-created universe 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 35 revisions of this API.