hiddenfield is only present if InstanceType ishiddenaka "Friends+", and is instance creator. *friendsfield is only present if InstanceType isfriendsaka "Friends", and is instance creator. *privatefield is only present if InstanceType isprivateaka "Invite" or "Invite+", and is instance creator.
| Name | Type | Description | Notes |
|---|---|---|---|
| active | bool | [default to True] | |
| age_gate | bool | [optional] | |
| can_request_invite | bool | [default to True] | |
| capacity | int | ||
| client_number | str | Always returns "unknown". | |
| display_name | str | ||
| full | bool | [default to False] | |
| game_server_version | int | ||
| id | str | 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. | |
| instance_id | str | ||
| instance_persistence_enabled | str | ||
| location | str | 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. | |
| n_users | int | ||
| name | str | ||
| owner_id | str | A groupId if the instance type is "group", null if instance type is public, or a userId otherwise | [optional] |
| permanent | bool | [default to False] | |
| photon_region | Region | ||
| platforms | InstancePlatforms | ||
| player_persistence_enabled | bool | ||
| region | InstanceRegion | ||
| secure_name | str | ||
| short_name | str | [optional] | |
| tags | list[str] | The tags array on Instances usually contain the language tags of the people in the instance. | |
| type | InstanceType | ||
| world_id | str | WorldID be "offline" on User profiles if you are not friends with that user. | |
| hidden | str | 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] |
| friends | str | 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] |
| private | str | 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] |
| queue_enabled | bool | ||
| queue_size | int | ||
| recommended_capacity | int | ||
| role_restricted | bool | [optional] | |
| strict | bool | ||
| user_count | int | ||
| world | World | ||
| users | list[LimitedUser] | The users field is present on instances created by the requesting user. | [optional] |
| group_access_type | GroupAccessType | [optional] | |
| has_capacity_for_you | bool | [optional] | |
| nonce | str | [optional] | |
| closed_at | datetime | [optional] | |
| hard_close | bool | [optional] |