VRChatBackendDocs/Models/Instance.md

Instance

Properties

Name	Type	Description	Notes
active	Boolean		[optional] [default to true]
ageGate	Boolean		[optional] [default to null]
calendarEntryId	String		[optional] [default to null]
canRequestInvite	Boolean		[optional] [default to true]
capacity	Integer		[optional] [default to null]
clientNumber	String	Always returns "unknown".	[default to null]
closedAt	Date		[optional] [default to null]
contentSettings	InstanceContentSettings		[optional] [default to null]
creatorId	String	A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.	[optional] [default to null]
displayName	String		[optional] [default to null]
friends	String	A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.	[optional] [default to null]
full	Boolean		[default to false]
gameServerVersion	Integer		[optional] [default to null]
groupAccessType	String	Group access type when the instance type is "group"	[optional] [default to members]
hardClose	Boolean		[optional] [default to null]
hasCapacityForYou	Boolean		[optional] [default to null]
hidden	String	A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.	[optional] [default to null]
id	String	InstanceID can be "offline" on User profiles if you are not friends with that user and "private" if you are friends and user is in private instance.	[default to null]
instanceId	String	InstanceID can be "offline" on User profiles if you are not friends with that user and "private" if you are friends and user is in private instance.	[default to null]
instancePersistenceEnabled	Boolean		[optional] [default to null]
location	String	Represents a unique location, consisting of a world identifier and an instance identifier, or "offline" if the user is not on your friends list.	[default to null]
n_users	Integer		[default to null]
name	String		[default to null]
nonce	String		[optional] [default to null]
ownerId	String	A groupId if the instance type is "group", null if instance type is public, or a userId otherwise	[optional] [default to null]
permanent	Boolean		[default to false]
photonRegion	String	API/Photon region.	[default to us]
platforms	InstancePlatforms		[default to null]
playerPersistenceEnabled	Boolean		[optional] [default to null]
private	String	A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed.	[optional] [default to null]
queueEnabled	Boolean		[default to null]
queueSize	Integer		[default to null]
recommendedCapacity	Integer		[default to null]
region	String	Instance region	[default to us]
roleRestricted	Boolean		[optional] [default to null]
secureName	String		[default to null]
shortName	String		[optional] [default to null]
strict	Boolean		[default to null]
tags	List	The tags array on Instances usually contain the language tags of the people in the instance.	[default to null]
type	String		[default to null]
userCount	Integer		[default to null]
users	List	The users field is present on instances created by the requesting user.	[optional] [default to null]
world	World		[default to null]
worldId	String	WorldID be "offline" on User profiles if you are not friends with that user.	[default to null]

[Back to Model list] [Back to API list] [Back to README]