Minecraft:Bedrock Realms API/Responses

The Bedrock Realms API response objects contain information about Minecraft:Realms, players, backups, downloads, and invitation links. Their fields and data types are listed below. For endpoints and response examples, see Minecraft:Bedrock Realms API.

Realm object

Describes a Realm and the subscription, world, and membership information visible to the caller.

Field	Type	Description
id	Integer	Realm identifier.
remoteSubscriptionId	String	Remote subscription identifier.
owner	String or null	Owner's username, mostly null.
ownerUUID	String	Owner's XUID, despite the field name.
name	String	Realm name.
motd	String or null	Realm description or message.
defaultPermission	String	Default player permission, such as VISITOR, MEMBER, or OPERATOR.
state	String	Realm state, such as OPEN or CLOSED.
daysLeft	Integer	Remaining subscription time in days. Values can be negative after expiry.
expired	Boolean	Whether the Realm subscription has expired.
expiredTrial	Boolean	Whether the Realm trial has expired.
gracePeriod	Boolean	Whether the subscription is in its grace period.
worldType	String	World type, such as NORMAL.
players	Array or null	Realm member records; see Player object. Can include members who are offline.
maxPlayers	Integer	Maximum player capacity.
activeSlot	Integer	Selected world slot.
slots	Array or null	World slot records. The options field can contain JSON encoded as a string.
member	Boolean	Membership flag reported by the service.
clubId	Integer or string	Associated Xbox club identifier.
minigameName	Unknown or null	Minigame name, when supplied.
minigameId	Unknown or null	Minigame identifier, when supplied.
minigameImage	Unknown or null	Minigame image information, when supplied.
subscriptionRefreshStatus	Unknown or null	Subscription refresh information, when supplied.

Player object

Describes a Realm member and the permissions and activity flags reported for that member.

Field	Type	Description
uuid	String	Player XUID.
name	String or null	Player name when supplied.
operator	Boolean	Whether the member is an operator.
accepted	Boolean	Whether the invitation has been accepted.
online	Boolean	Reported online status.
permission	String	Reported permission level.

Backup object

Identifies a saved world backup and its metadata.

Field	Type	Description
backupId	String	Backup identifier used by download and restore routes.
lastModifiedDate	Integer	Modification time as a Unix timestamp in milliseconds.
size	Integer	Reported backup size in bytes.
metadata	Object	World details such as name, version, difficulty, game mode, and enabled packs. The values can be serialized strings.

Download object

Provides the download location and token for a world archive.

Field	Type	Description
downloadUrl	String	Archive download location.
token	String	Token used when downloading the archive.
size	Integer	Reported download size in bytes.

World archive downloads use Authorization: Bearer {token}, with the token supplied by the download object.

Invite link object

Describes a Realm invite code and its web and game links.

Field	Type	Description
linkId	String	Invite code.
profileUuid	String	Associated owner profile XUID.
type	String	Link type, such as INFINITE.
ts	Integer	Link creation timestamp.
url	String	Web link of the form https://realms.gg/{linkId}.
deepLinkUrl	String	Game link of the form minecraft://acceptRealmInvite?inviteID={linkId}.