parameters.yaml

active:
  name: active
  description: Filter for users' listings and inventory bundles.
  required: false
  in: query
  schema:
    type: boolean
actorIds:
  name: actorIds
  description: The comma-separated actor ids to search for.
  required: false
  in: query
  schema:
    type: string
    example: usr_00000000-0000-0000-0000-000000000000,usr_11111111-1111-1111-1111-111111111111
adminAssetBundleId:
  name: adminAssetBundleId
  description: Must be a valid admin asset bundle ID.
  required: true
  in: path
  schema:
    type: string
    example: aab_e159e72c-ce54-4fbe-8c37-96af02f6d18d
assetReviewId:
  name: assetReviewId
  description: Must be an valid asset review ID.
  required: true
  in: path
  schema:
    type: string
authorId:
  name: authorId
  description: Must be a valid user ID.
  required: true
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
avatarId:
  name: avatarId
  description: Must be a valid avatar ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/AvatarID.yaml
avatarModerationType:
  name: avatarModerationType
  description: The avatar moderation type associated with the avatar.
  required: true
  in: query
  schema:
    $ref: ./schemas/AvatarModerationType.yaml
avatarSpecific:
  name: avatarSpecific
  description: Only search for avatar worlds.
  required: false
  in: query
  schema:
    type: boolean
badgeId:
  name: badgeId
  description: Must be a valid badge ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/BadgeID.yaml
branch:
  name: branch
  description: Specifies which git branch the site should load frontend source code from.
  required: false
  allowEmptyValue: true
  in: query
  schema:
    type: string
    default: main
buyerId:
  name: buyerId
  description: Must be a valid user ID.
  required: true
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
calendarDiscoveryCategories:
  name: categories
  description: Filter for calendar event discovery.
  required: false
  in: query
  schema:
    type: string
    description: Comma-separated list of calendar event categories
    example: "avatars,exploration,gaming,roleplaying,music,performance"
calendarDiscoveryFeatured:
  name: featuredResults
  description: Filter for calendar event discovery.
  required: false
  in: query
  schema:
    $ref: ./schemas/CalendarEventDiscoveryInclusion.yaml
calendarDiscoveryMinimumInterestCount:
  name: minimumInterestCount
  description: Filter for calendar event discovery.
  required: false
  in: query
  schema:
    type: integer
    example: 5
calendarDiscoveryMinimumRemainingMinutes:
  name: minimumRemainingMinutes
  description: Filter for calendar event discovery.
  required: false
  in: query
  schema:
    type: integer
    example: 10
calendarDiscoveryNextCursor:
  name: nextCursor
  description: Cursor returned from previous calendar discovery queries (see nextCursor property of the schema CalendarEventDiscovery).
  required: false
  in: query
  schema:
    type: string
    format: string
calendarDiscoveryNonFeatured:
  name: nonFeaturedResults
  description: Filter for calendar event discovery.
  required: false
  in: query
  schema:
    $ref: ./schemas/CalendarEventDiscoveryInclusion.yaml
calendarDiscoveryPersonalized:
  name: personalizedResults
  description: Filter for calendar event discovery.
  required: false
  in: query
  schema:
    $ref: ./schemas/CalendarEventDiscoveryInclusion.yaml
calendarDiscoveryScope:
  name: scope
  description: Scope for calendar event discovery.
  required: false
  in: query
  schema:
    $ref: ./schemas/CalendarEventDiscoveryScope.yaml
calendarDiscoveryTags:
  name: tags
  description: Filter for calendar event discovery.
  required: false
  in: query
  schema:
    type: string
    description: Comma-separated list of calendar event tags
    example: vrc_event_group_fair
calendarDiscoveryUpcomingOffsetMinutes:
  name: upcomingOffsetMinutes
  description: Filter for calendar event discovery.
  required: false
  in: query
  schema:
    type: integer
    example: 10080
calendarId:
  name: calendarId
  description: Must be a valid calendar ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/CalendarID.yaml
calendarSearchTerm:
  name: searchTerm
  description: Search term for calendar events.
  required: true
  in: query
  schema:
    type: string
    example: game night
confirmEmailToken:
  name: verify_email
  description: Token to verify email.
  required: true
  in: query
  schema:
    type: string
    example: eml_00000000-0000-0000-0000-000000000000
confirmEmailUserId:
  name: id
  description: Target user for which to verify email.
  required: true
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
contentId:
  name: contentId
  description: Filter for particular content submitted, e.g., a groupId, userId, avatarId, etc.
  required: false
  in: query
  schema:
    type: string
dateMax:
  name: dateMax
  description: The end date of the search range.
  required: false
  in: query
  schema:
    type: string
    format: date-time
dateMin:
  name: dateMin
  description: The start date of the search range.
  required: false
  in: query
  schema:
    type: string
    format: date-time
displayName:
  name: displayName
  description: Filter by displayName.
  required: false
  in: query
  schema:
    type: string
email:
  name: email
  description: Filter by email.
  required: false
  in: query
  schema:
    type: string
endDate:
  name: endDate
  description: The end date of the search range.
  required: false
  in: query
  schema:
    type: string
    format: date-time
eventTypes:
  name: eventTypes
  description: The comma-separated event types to search for.
  required: false
  in: query
  schema:
    type: string
    example: group.member.remove,group.instance.kick
excludeUserId:
  name: excludeUserId
  description: Exclude by UserID.
  required: false
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
favoriteGroupName:
  name: favoriteGroupName
  description: "The name of the group to fetch, must be a name of a FavoriteGroup."
  required: true
  in: path
  schema:
    $ref: ./schemas/FavoriteName.yaml
favoriteGroupType:
  name: favoriteGroupType
  description: "The type of group to fetch, must be a valid FavoriteType."
  required: true
  in: path
  schema:
    $ref: ./schemas/FavoriteType.yaml
favoriteId:
  name: favoriteId
  description: Must be a valid favorite ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/FavoriteID.yaml
featured:
  name: featured
  description: Filters on featured results.
  required: false
  in: query
  schema:
    type: boolean
fileId:
  name: fileId
  description: Must be a valid file ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/FileID.yaml
fileType:
  name: fileType
  description: Type of file.
  required: true
  in: path
  schema:
    type: string
    enum:
      - delta
      - file
      - signature
    example: file
fromUserId:
  name: fromUserId
  description: Must be a valid user ID.
  required: false
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
fuzzy:
  name: fuzzy
  required: false
  in: query
  schema:
    type: boolean
groupGalleryId:
  name: groupGalleryId
  description: Must be a valid group gallery ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/GroupGalleryID.yaml
groupGalleryImageId:
  name: groupGalleryImageId
  description: Must be a valid group gallery image ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/GroupGalleryImageID.yaml
groupId:
  name: groupId
  description: Must be a valid group ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/GroupID.yaml
groupIdFilter:
  name: groupId
  description: Must be a valid group ID.
  required: false
  in: query
  schema:
    $ref: ./schemas/GroupID.yaml
groupMemberRoleFilter:
  name: roleId
  description: Only returns members with a specific groupRoleId
  required: false
  in: query
  schema:
    $ref: ./schemas/GroupRoleID.yaml
groupMemberSort:
  name: sort
  description: The sort order of Group Member results
  required: false
  in: query
  schema:
    $ref: ./schemas/GroupSearchSort.yaml
groupRoleId:
  name: groupRoleId
  description: Must be a valid group role ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/GroupRoleID.yaml
hydrate:
  name: hydrate
  description: Populates some fields and changes types of others for certain objects.
  required: false
  in: query
  schema:
    type: boolean
hydrateListings:
  name: hydrateListings
  description: Listings fields will be populated.
  required: false
  in: query
  schema:
    type: boolean
hydrateProducts:
  name: hydrateProducts
  description: Products fields will be populated.
  required: false
  in: query
  schema:
    type: boolean
include:
  name: include
  description: Tags to include (comma-separated). Any of the tags needs to be present.
  required: false
  in: query
  schema:
    $ref: ./schemas/Tag.yaml
instanceId:
  name: instanceId
  description: Must be a valid instance ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/InstanceID.yaml
inventoryEquipSlot:
  name: equipSlot
  description: Filter for inventory retrieval.
  required: false
  in: query
  schema:
    $ref: ./schemas/InventoryEquipSlot.yaml
inventoryHolderId:
  name: holderId
  description: The UserID of the owner of the inventory; defaults to the currently authenticated user.
  required: false
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
inventoryItemArchived:
  name: archived
  description: Filter archived status for inventory retrieval.
  required: false
  in: query
  schema:
    type: boolean
inventoryItemFlags:
  name: flags
  description: Filter flags for inventory retrieval (comma-separated).
  required: false
  in: query
  schema:
    $ref: ./schemas/InventoryFlag.yaml
inventoryItemId:
  name: inventoryItemId
  description: Must be a valid inventory item ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/InventoryItemID.yaml
inventoryItemNotFlags:
  name: notFlags
  description: Filter out flags for inventory retrieval (comma-separated).
  required: false
  in: query
  schema:
    $ref: ./schemas/InventoryFlag.yaml
inventoryItemNotTypes:
  name: notTypes
  description: Filter out types for inventory retrieval (comma-separated).
  required: false
  in: query
  schema:
    $ref: ./schemas/InventoryItemType.yaml
inventoryItemSlotAsId:
  name: inventoryItemId
  description: Selector for inventory slot management.
  required: true
  in: path
  schema:
    $ref: ./schemas/InventoryEquipSlot.yaml
inventoryItemTags:
  name: tags
  description: Filter tags for inventory retrieval (comma-separated).
  required: false
  in: query
  schema:
    $ref: ./schemas/Tag.yaml
inventoryItemTypes:
  name: types
  description: Filter for inventory retrieval.
  required: false
  in: query
  schema:
    $ref: ./schemas/InventoryItemType.yaml
inventoryPedestalDuration:
  name: duration
  description: The duration before the sharing pedestal despawns.
  required: true
  in: query
  schema:
    type: integer
    default: 90
    maximum: 86400
    minimum: 30
inventoryPedestalItemId:
  name: itemId
  description: Id for inventory item sharing.
  required: true
  in: query
  schema:
    $ref: ./schemas/InventoryItemID.yaml
inventorySortOrder:
  name: order
  description: Sort order for inventory retrieval.
  required: false
  in: query
  schema:
    type: string
    enum:
      - newest
      - newest_created
      - oldest
      - oldest_created
inventorySpawnItemId:
  name: id
  description: Id for inventory item spawning.
  required: true
  in: query
  schema:
    $ref: ./schemas/InventoryItemID.yaml
inventoryTemplateId:
  name: inventoryTemplateId
  description: Must be a valid inventory template ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/InventoryTemplateID.yaml
isInternalVariant:
  name: isInternalVariant
  description: Not quite sure what this actually does (exists on the website but doesn't seem to be used)
  required: false
  in: query
  schema:
    type: boolean
    example: false
jamId:
  name: jamId
  description: Must be a valid jam ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/JamID.yaml
jamSubmissionId:
  name: jamSubmissionId
  description: Must be a valid jam submission ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/JamSubmissionID.yaml
licenseGroupId:
  name: licenseGroupId
  description: Must be a valid license group ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/LicenseGroupID.yaml
limit:
  name: limit
  description: The maximum number of entries to get.
  required: false
  in: query
  schema:
    type: integer
    example: 100
maxUnityVersion:
  name: maxUnityVersion
  description: The maximum Unity version supported by the asset.
  required: false
  in: query
  schema:
    type: string
messageType:
  name: messageType
  description: "The type of message to fetch, must be a valid InviteMessageType."
  required: true
  in: path
  schema:
    $ref: ./schemas/InviteMessageType.yaml
metadata:
  name: metadata
  description: Which metadata fields to include (comma-separated).
  required: false
  in: query
  schema:
    type: string
minUnityVersion:
  name: minUnityVersion
  description: The minimum Unity version supported by the asset.
  required: false
  in: query
  schema:
    type: string
moderationReportId:
  name: moderationReportId
  description: The moderation report id.
  required: true
  in: path
  schema:
    $ref: ./schemas/ModerationReportID.yaml
moderationReportStatus:
  name: status
  description: "Filter for moderation reports. One of: `closed`..."
  required: false
  in: query
  schema:
    type: string
moderationReportType:
  name: type
  description: "Filter for moderation reports. One of: `avatar`, `group`, `user`, `world`..."
  required: false
  in: query
  schema:
    type: string
moderationReportingUserId:
  name: reportingUserId
  description: Filter for moderation reports.
  required: false
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
monthDate:
  name: date
  description: The month to search in.
  required: false
  in: query
  schema:
    type: string
    format: date-time
mostRecentFlag:
  name: mostRecent
  required: false
  in: query
  schema:
    type: boolean
noplatform:
  name: noplatform
  description: The platform the asset does not support.
  required: false
  in: query
  schema:
    type: string
notag:
  name: notag
  description: Tags to exclude (comma-separated).
  required: false
  in: query
  schema:
    $ref: ./schemas/Tag.yaml
notificationId:
  name: notificationId
  description: Must be a valid notification ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/NotificationID.yaml
number:
  name: n
  description: The number of objects to return.
  required: false
  in: query
  schema:
    type: integer
    default: 60
    maximum: 100
    minimum: 1
offline:
  name: offline
  description: "Returns *only* offline users if true, returns only online and active users if false"
  required: false
  in: query
  schema:
    type: boolean
offset:
  name: offset
  description: A zero-based offset from the default object sorting from where search results start.
  required: false
  in: query
  schema:
    type: integer
    minimum: 0
order:
  name: order
  description: Result ordering
  required: false
  in: query
  schema:
    $ref: ./schemas/OrderOption.yaml
orderShort:
  name: order
  description: Result ordering
  required: false
  in: query
  schema:
    $ref: ./schemas/OrderOptionShort.yaml
permissionId:
  name: permissionId
  description: Must be a valid permission ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/PermissionID.yaml
platform:
  name: platform
  description: The platform the asset supports.
  required: false
  in: query
  schema:
    $ref: ./schemas/Platform.yaml
printId:
  name: printId
  description: Print ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/PrintID.yaml
productId:
  name: productId
  description: Must be a valid product ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/ProductID.yaml
productPurchaseId:
  name: productPurchaseId
  description: Must be a valid purchase ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/ProductPurchaseID.yaml
propId:
  name: propId
  description: Prop ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/PropID.yaml
publishedPlatform:
  name: publishedPlatform
  description: A platform the world supports.
  required: true
  in: path
  schema:
    $ref: ./schemas/Platform.yaml
releaseStatus:
  name: releaseStatus
  description: Filter by ReleaseStatus.
  required: false
  in: query
  schema:
    $ref: ./schemas/ReleaseStatus.yaml
require:
  name: require
  description: Tags to include (comma-separated). All of the tags needs to be present.
  required: false
  in: query
  schema:
    $ref: ./schemas/Tag.yaml
search:
  name: search
  description: Filters by world name.
  required: false
  in: query
  schema:
    type: string
slot:
  name: slot
  description: The message slot to fetch of a given message type.
  required: true
  in: path
  schema:
    type: integer
    maximum: 11
    minimum: 0
sort:
  name: sort
  description: The sort order of the results.
  required: false
  in: query
  schema:
    $ref: ./schemas/SortOption.yaml
sortProductPurchase:
  name: sort
  description: The sort order of the results.
  required: false
  in: query
  schema:
    $ref: ./schemas/SortOptionProductPurchase.yaml
startDate:
  name: startDate
  description: The start date of the search range.
  required: false
  in: query
  schema:
    type: string
    format: date-time
steamId:
  name: steamId
  description: The Steam ID of the user.
  required: false
  in: query
  schema:
    type: string
    example: game night
storeId:
  name: storeId
  required: true
  in: query
  schema:
    $ref: ./schemas/StoreID.yaml
storeView:
  name: fetch
  required: false
  in: query
  schema:
    $ref: ./schemas/StoreView.yaml
submitterId:
  name: submitterId
  description: Must be a valid user ID.
  required: false
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
subscriptionId:
  name: subscriptionId
  required: true
  in: query
  schema:
    type: string
tag:
  name: tag
  description: Tags to include (comma-separated). Any of the tags needs to be present.
  required: false
  in: query
  schema:
    $ref: ./schemas/Tag.yaml
targetAvatarId:
  name: targetAvatarId
  description: Must be a valid avatar ID.
  required: true
  in: query
  schema:
    $ref: ./schemas/AvatarID.yaml
targetIds:
  name: targetIds
  description: The comma-separated target ids to search for.
  required: false
  in: query
  schema:
    type: string
    example: usr_00000000-0000-0000-0000-000000000000,usr_11111111-1111-1111-1111-111111111111
toUserId:
  name: toUserId
  description: Must be a valid user ID.
  required: false
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
transactionId:
  name: transactionId
  description: Must be a valid transaction ID.
  required: true
  in: path
  schema:
    type: string
userId:
  name: userId
  description: Must be a valid user ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/UserID.yaml
userIdAdmin:
  name: userId
  description: "Target user to see information on, admin-only."
  required: false
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
userIdQuery:
  name: userId
  description: Filter by UserID.
  required: false
  in: query
  schema:
    $ref: ./schemas/UserID.yaml
userNoteId:
  name: userNoteId
  description: Must be a valid user note ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/UserNoteID.yaml
usernameQuery:
  name: username
  description: Filter by Username.
  required: false
  in: query
  schema:
    type: string
utcOffset:
  name: utcOffset
  description: The offset from UTC in hours of the client or authenticated user.
  required: false
  in: query
  schema:
    type: integer
    maximum: 12
    minimum: -12
variant:
  name: variant
  description: "Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management."
  required: false
  allowEmptyValue: true
  in: query
  schema:
    type: string
    enum:
      - internal
      - public
    default: public
verifyLoginPlaceToken:
  name: token
  description: Token to verify login attempt.
  required: true
  in: query
  schema:
    type: string
versionId:
  name: versionId
  description: Version ID of the asset.
  required: true
  in: path
  schema:
    type: integer
    example: 1
    minimum: 1
worldId:
  name: worldId
  description: Must be a valid world ID.
  required: true
  in: path
  schema:
    $ref: ./schemas/WorldID.yaml