title: Instance
type: object
description: |-
  * `hidden` field is only present if InstanceType is `hidden` aka "Friends+", and is instance creator.
  * `friends` field is only present if InstanceType is `friends` aka "Friends", and is instance creator.
  * `private` field is only present if InstanceType is `private` aka "Invite" or "Invite+", and is instance creator.
properties:
  active:
    type: boolean
    default: true
    examples:
      - true
  ageGate:
    type:
      - boolean
      - "null"
  calendarEntryId:
    type:
      - string
      - "null"
  canRequestInvite:
    type: boolean
    default: true
    examples:
      - true
  capacity:
    type: integer
    examples:
      - 8
    minimum: 0
  categoryId:
    anyOf:
      - $ref: ./InstanceCategoryID.yaml
      - type: "null"
  clientNumber:
    deprecated: true
    type: string
    description: Always returns "unknown".
    minLength: 1
  closedAt:
    type:
      - string
      - "null"
    format: date-time
  contentSettings:
    $ref: ./InstanceContentSettings.yaml
  creationLanguages:
    type: array
    items:
      $ref: ./Unknown.yaml
  creatorId:
    anyOf:
      - $ref: ./UserID.yaml
      - type: "null"
  description:
    type:
      - string
      - "null"
  disabledPropAbilities:
    type: array
    items:
      $ref: ./Unknown.yaml
  displayName:
    type:
      - string
      - "null"
  displayVibeId:
    anyOf:
      - $ref: ./InstanceVibeID.yaml
      - type: "null"
  dominantLanguage:
    type: string
  friends:
    $ref: ./UserID.yaml
  full:
    type: boolean
    default: false
  gameServerVersion:
    type:
      - integer
      - "null"
  groupAccessType:
    $ref: ./GroupAccessType.yaml
  hardClose:
    type:
      - boolean
      - "null"
  hasCapacityForYou:
    type: boolean
  hidden:
    $ref: ./UserID.yaml
  id:
    $ref: ./InstanceID.yaml
  instanceId:
    $ref: ./InstanceID.yaml
  instancePersistenceEnabled:
    type:
      - boolean
      - "null"
  languageRatio:
    type: object
    additionalProperties: true
  languages:
    type: array
    description: The keys of languageRatio, ordered by their share of the instance.
    items:
      type: string
      examples:
        - en
  languagesIso639:
    type: array
    items:
      $ref: ./LanguageCode.yaml
  location:
    $ref: ./LocationID.yaml
  minimumAvatarPerformance:
    type:
      - string
      - "null"
  n_users:
    type: integer
    examples:
      - 6
    minimum: 0
  name:
    type: string
    examples:
      - "12345"
    minLength: 1
  nonce:
    type: string
  ownerId:
    $ref: ./InstanceOwnerId.yaml
  permanent:
    type: boolean
    default: false
  photonRegion:
    $ref: ./Region.yaml
  platforms:
    $ref: ./InstancePlatforms.yaml
  playerPersistenceEnabled:
    type:
      - boolean
      - "null"
  private:
    $ref: ./UserID.yaml
  queueEnabled:
    type: boolean
  queueSize:
    type: integer
    examples:
      - 6
    minimum: 0
  recommendedCapacity:
    type: integer
    examples:
      - 6
    minimum: 0
  region:
    $ref: ./InstanceRegion.yaml
  roleRestricted:
    type: boolean
  secureName:
    type: string
    examples:
      - 7eavhhng
    minLength: 1
  shortName:
    type:
      - string
      - "null"
    examples:
      - 02u7yz8j
    minLength: 1
  strict:
    type: boolean
  tags:
    type: array
    description: "The tags array on Instances usually contain the language tags of the people in the instance. "
    examples:
      -
        - language_eng
        - language_jpn
        - show_social_rank
    items:
      $ref: ./Tag.yaml
  type:
    $ref: ./InstanceType.yaml
  userCount:
    type: integer
    examples:
      - 6
    minimum: 0
  userIcons:
    type: array
    items:
      type: string
      examples:
        - https://api.vrchat.cloud/api/1/image/file_12ca2b06-c08d-4023-b06f-b60691d9946e/1/256
  users:
    type: array
    description: The users field is present on instances created by the requesting user.
    items:
      $ref: ./LimitedUserInstance.yaml
  vibeIds:
    type: array
    items:
      $ref: ./InstanceVibeID.yaml
  world:
    $ref: ./World.yaml
  worldId:
    $ref: ./WorldID.yaml
required:
  - clientNumber
  - full
  - id
  - instanceId
  - location
  - n_users
  - name
  - permanent
  - photonRegion
  - platforms
  - queueEnabled
  - queueSize
  - recommendedCapacity
  - region
  - secureName
  - strict
  - tags
  - type
  - userCount
  - world
  - worldId