Documentation for VRChat API Documentation
Documentation for API Endpoints
All URIs are relative to https://api.vrchat.cloud/api/1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthenticationApi | cancelPending2FA | DELETE /auth/twofactorauth/totp/pending | Cancel pending enabling of time-based 2FA codes |
| AuthenticationApi | checkUserExists | GET /auth/exists | Check User Exists |
| AuthenticationApi | confirmEmail | GET /auth/confirmEmail | Confirm Email |
| AuthenticationApi | createGlobalAvatarModeration | POST /auth/user/avatarmoderations | Create Global Avatar Moderation |
| AuthenticationApi | deleteGlobalAvatarModeration | DELETE /auth/user/avatarmoderations | Delete Global Avatar Moderation |
| AuthenticationApi | deleteModerationReport | DELETE /moderationReports/{moderationReportId} | Delete Moderation Report |
| AuthenticationApi | deleteUser | PUT /users/{userId}/delete | Delete User |
| AuthenticationApi | disable2FA | DELETE /auth/twofactorauth | Disable 2FA |
| AuthenticationApi | enable2FA | POST /auth/twofactorauth/totp/pending | Enable time-based 2FA codes |
| AuthenticationApi | getCurrentUser | GET /auth/user | Login and/or Get Current User Info |
| AuthenticationApi | getGlobalAvatarModerations | GET /auth/user/avatarmoderations | Get Global Avatar Moderations |
| AuthenticationApi | getModerationReports | GET /moderationReports | Get Moderation Reports |
| AuthenticationApi | getRecoveryCodes | GET /auth/user/twofactorauth/otp | Get 2FA Recovery codes |
| AuthenticationApi | logout | PUT /logout | Logout |
| AuthenticationApi | registerUserAccount | POST /auth/register | Register User Account |
| AuthenticationApi | resendEmailConfirmation | POST /auth/user/resendEmail | Resend Email Confirmation |
| AuthenticationApi | submitModerationReport | POST /moderationReports | Submit Moderation Report |
| AuthenticationApi | verify2FA | POST /auth/twofactorauth/totp/verify | Verify 2FA code |
| AuthenticationApi | verify2FAEmailCode | POST /auth/twofactorauth/emailotp/verify | Verify 2FA email code |
| AuthenticationApi | verifyAuthToken | GET /auth | Verify Auth Token |
| AuthenticationApi | verifyLoginPlace | GET /auth/verifyLoginPlace | Verify Login Place |
| AuthenticationApi | verifyPending2FA | POST /auth/twofactorauth/totp/pending/verify | Verify Pending 2FA code |
| AuthenticationApi | verifyRecoveryCode | POST /auth/twofactorauth/otp/verify | Verify 2FA code with Recovery code |
| AvatarsApi | createAvatar | POST /avatars | Create Avatar |
| AvatarsApi | deleteAvatar | DELETE /avatars/{avatarId} | Delete Avatar |
| AvatarsApi | deleteImpostor | DELETE /avatars/{avatarId}/impostor | Delete generated Impostor |
| AvatarsApi | enqueueImpostor | POST /avatars/{avatarId}/impostor/enqueue | Enqueue Impostor generation |
| AvatarsApi | getAvatar | GET /avatars/{avatarId} | Get Avatar |
| AvatarsApi | getAvatarStyles | GET /avatarStyles | Get Avatar Styles |
| AvatarsApi | getFavoritedAvatars | GET /avatars/favorites | List Favorited Avatars |
| AvatarsApi | getImpostorQueueStats | GET /avatars/impostor/queue/stats | Get Impostor Queue Stats |
| AvatarsApi | getLicensedAvatars | GET /avatars/licensed | List Licensed Avatars |
| AvatarsApi | getOwnAvatar | GET /users/{userId}/avatar | Get Own Avatar |
| AvatarsApi | searchAvatars | GET /avatars | Search Avatars |
| AvatarsApi | selectAvatar | PUT /avatars/{avatarId}/select | Select Avatar |
| AvatarsApi | selectFallbackAvatar | PUT /avatars/{avatarId}/selectFallback | Select Fallback Avatar |
| AvatarsApi | updateAvatar | PUT /avatars/{avatarId} | Update Avatar |
| CalendarApi | createGroupCalendarEvent | POST /calendar/{groupId}/event | Create a calendar event |
| CalendarApi | deleteGroupCalendarEvent | DELETE /calendar/{groupId}/{calendarId} | Delete a calendar event |
| CalendarApi | discoverCalendarEvents | GET /calendar/discover | Discover calendar events |
| CalendarApi | followGroupCalendarEvent | POST /calendar/{groupId}/{calendarId}/follow | Follow a calendar event |
| CalendarApi | getCalendarEvents | GET /calendar | List calendar events |
| CalendarApi | getFeaturedCalendarEvents | GET /calendar/featured | List featured calendar events |
| CalendarApi | getFollowedCalendarEvents | GET /calendar/following | List followed calendar events |
| CalendarApi | getGroupCalendarEvent | GET /calendar/{groupId}/{calendarId} | Get a calendar event |
| CalendarApi | getGroupCalendarEventICS | GET /calendar/{groupId}/{calendarId}.ics | Download calendar event as ICS |
| CalendarApi | getGroupCalendarEvents | GET /calendar/{groupId} | List a group's calendar events |
| CalendarApi | getGroupNextCalendarEvent | GET /calendar/{groupId}/next | Get next calendar event |
| CalendarApi | searchCalendarEvents | GET /calendar/search | Search for calendar events |
| CalendarApi | updateGroupCalendarEvent | PUT /calendar/{groupId}/{calendarId}/event | Update a calendar event |
| EconomyApi | getActiveLicenses | GET /economy/licenses/active | Get Active Licenses |
| EconomyApi | getBalance | GET /user/{userId}/balance | Get Balance |
| EconomyApi | getBalanceEarnings | GET /user/{userId}/balance/earnings | Get Balance Earnings |
| EconomyApi | getBulkGiftPurchases | GET /user/bulk/gift/purchases | Get Bulk Gift Purchases |
| EconomyApi | getCurrentSubscriptions | GET /auth/user/subscription | Get Current Subscriptions |
| EconomyApi | getEconomyAccount | GET /user/{userId}/economy/account | Get Economy Account |
| EconomyApi | getLicenseGroup | GET /licenseGroups/{licenseGroupId} | Get License Group |
| EconomyApi | getProductListing | GET /listing/{productId} | Get Product Listing |
| EconomyApi | getProductListingAlternate | GET /products/{productId} | Get Product Listing (alternate) |
| EconomyApi | getProductListings | GET /user/{userId}/listings | Get User Product Listings |
| EconomyApi | getProductPurchases | GET /economy/purchases | Get Product Purchases |
| EconomyApi | getRecentSubscription | GET /user/subscription/recent | Get Recent Subscription |
| EconomyApi | getSteamTransaction | GET /Steam/transactions/{transactionId} | Get Steam Transaction |
| EconomyApi | getSteamTransactions | GET /Steam/transactions | List Steam Transactions |
| EconomyApi | getStore | GET /economy/store | Get Store |
| EconomyApi | getStoreShelves | GET /economy/store/shelves | Get Store Shelves |
| EconomyApi | getSubscriptions | GET /subscriptions | List Subscriptions |
| EconomyApi | getTiliaStatus | GET /tilia/status | Get Tilia Status |
| EconomyApi | getTiliaTos | GET /user/{userId}/tilia/tos | Get Tilia TOS Agreement Status |
| EconomyApi | getTokenBundles | GET /tokenBundles | List Token Bundles |
| EconomyApi | getUserCreditsEligible | GET /users/{userId}/credits/eligible | Get User Credits Eligiblity |
| EconomyApi | getUserSubscriptionEligible | GET /users/{userId}/subscription/eligible | Get User Subscription Eligiblity |
| EconomyApi | purchaseProductListing | POST /economy/purchase/listing | Purchase Product Listing |
| EconomyApi | updateTiliaTos | PUT /user/{userId}/tilia/tos | Update Tilia TOS Agreement Status |
| FavoritesApi | addFavorite | POST /favorites | Add Favorite |
| FavoritesApi | clearFavoriteGroup | DELETE /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId} | Clear Favorite Group |
| FavoritesApi | getFavoriteGroup | GET /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId} | Show Favorite Group |
| FavoritesApi | getFavoriteGroups | GET /favorite/groups | List Favorite Groups |
| FavoritesApi | getFavoriteLimits | GET /auth/user/favoritelimits | Get Favorite Limits |
| FavoritesApi | getFavorites | GET /favorites | List Favorites |
| FavoritesApi | removeFavorite | DELETE /favorites/{favoriteId} | Remove Favorite |
| FavoritesApi | updateFavoriteGroup | PUT /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId} | Update Favorite Group |
| FilesApi | createFile | POST /file | Create File |
| FilesApi | createFileVersion | POST /file/{fileId} | Create File Version |
| FilesApi | deleteFile | DELETE /file/{fileId} | Delete File |
| FilesApi | deleteFileVersion | DELETE /file/{fileId}/{versionId} | Delete File Version |
| FilesApi | downloadFileVersion | GET /file/{fileId}/{versionId} | Download File Version |
| FilesApi | finishFileDataUpload | PUT /file/{fileId}/{versionId}/{fileType}/finish | Finish FileData Upload |
| FilesApi | getAdminAssetBundle | GET /adminassetbundles/{adminAssetBundleId} | Get AdminAssetBundle |
| FilesApi | getContentAgreementStatus | GET /agreement | Get Content Agreement Status |
| FilesApi | getFile | GET /file/{fileId} | Show File |
| FilesApi | getFileAnalysis | GET /analysis/{fileId}/{versionId} | Get File Version Analysis |
| FilesApi | getFileAnalysisSecurity | GET /analysis/{fileId}/{versionId}/security | Get File Version Analysis Security |
| FilesApi | getFileAnalysisStandard | GET /analysis/{fileId}/{versionId}/standard | Get File Version Analysis Standard |
| FilesApi | getFileDataUploadStatus | GET /file/{fileId}/{versionId}/{fileType}/status | Check FileData Upload Status |
| FilesApi | getFiles | GET /files | List Files |
| FilesApi | setGroupGalleryFileOrder | PUT /files/order | Set Group Gallery File Order |
| FilesApi | startFileDataUpload | PUT /file/{fileId}/{versionId}/{fileType}/start | Start FileData Upload |
| FilesApi | submitContentAgreement | POST /agreement | Submit Content Agreement |
| FilesApi | updateAssetReviewNotes | PUT /assetReview/{assetReviewId}/notes | Update Asset Review Notes |
| FilesApi | uploadGalleryImage | POST /gallery | Upload gallery image |
| FilesApi | uploadIcon | POST /icon | Upload icon |
| FilesApi | uploadImage | POST /file/image | Upload gallery image, icon, emoji or sticker |
| FriendsApi | boop | POST /users/{userId}/boop | Send Boop |
| FriendsApi | deleteFriendRequest | DELETE /user/{userId}/friendRequest | Delete Friend Request |
| FriendsApi | friend | POST /user/{userId}/friendRequest | Send Friend Request |
| FriendsApi | getFriendStatus | GET /user/{userId}/friendStatus | Check Friend Status |
| FriendsApi | getFriends | GET /auth/user/friends | List Friends |
| FriendsApi | unfriend | DELETE /auth/user/friends/{userId} | Unfriend |
| GroupsApi | addGroupGalleryImage | POST /groups/{groupId}/galleries/{groupGalleryId}/images | Add Group Gallery Image |
| GroupsApi | addGroupMemberRole | PUT /groups/{groupId}/members/{userId}/roles/{groupRoleId} | Add Role to GroupMember |
| GroupsApi | addGroupPost | POST /groups/{groupId}/posts | Create a post in a Group |
| GroupsApi | banGroupMember | POST /groups/{groupId}/bans | Ban Group Member |
| GroupsApi | blockGroup | POST /groups/{groupId}/block | Block Group |
| GroupsApi | cancelGroupRequest | DELETE /groups/{groupId}/requests | Cancel Group Join Request |
| GroupsApi | cancelGroupTransfer | DELETE /groups/{groupId}/transfer | Cancel Group Transfer |
| GroupsApi | createGroup | POST /groups | Create Group |
| GroupsApi | createGroupAnnouncement | POST /groups/{groupId}/announcement | Create Group Announcement |
| GroupsApi | createGroupGallery | POST /groups/{groupId}/galleries | Create Group Gallery |
| GroupsApi | createGroupInvite | POST /groups/{groupId}/invites | Invite User to Group |
| GroupsApi | createGroupRole | POST /groups/{groupId}/roles | Create GroupRole |
| GroupsApi | declineGroupInvite | PUT /groups/{groupId}/invites | Decline Invite from Group |
| GroupsApi | deleteGroup | DELETE /groups/{groupId} | Delete Group |
| GroupsApi | deleteGroupAnnouncement | DELETE /groups/{groupId}/announcement | Delete Group Announcement |
| GroupsApi | deleteGroupGallery | DELETE /groups/{groupId}/galleries/{groupGalleryId} | Delete Group Gallery |
| GroupsApi | deleteGroupGalleryImage | DELETE /groups/{groupId}/galleries/{groupGalleryId}/images/{groupGalleryImageId} | Delete Group Gallery Image |
| GroupsApi | deleteGroupInvite | DELETE /groups/{groupId}/invites/{userId} | Delete User Invite |
| GroupsApi | deleteGroupPost | DELETE /groups/{groupId}/posts/{notificationId} | Delete a Group post |
| GroupsApi | deleteGroupRole | DELETE /groups/{groupId}/roles/{groupRoleId} | Delete Group Role |
| GroupsApi | getGroup | GET /groups/{groupId} | Get Group by ID |
| GroupsApi | getGroupAnnouncements | GET /groups/{groupId}/announcement | Get Group Announcement |
| GroupsApi | getGroupAuditLogEntryTypes | GET /groups/{groupId}/auditLogTypes | Get Group Audit Log Entry Types |
| GroupsApi | getGroupAuditLogs | GET /groups/{groupId}/auditLogs | Get Group Audit Logs |
| GroupsApi | getGroupBans | GET /groups/{groupId}/bans | Get Group Bans |
| GroupsApi | getGroupGalleryImages | GET /groups/{groupId}/galleries/{groupGalleryId} | Get Group Gallery Images |
| GroupsApi | getGroupInstances | GET /groups/{groupId}/instances | Get Group Instances |
| GroupsApi | getGroupInvites | GET /groups/{groupId}/invites | Get Group Invites Sent |
| GroupsApi | getGroupMember | GET /groups/{groupId}/members/{userId} | Get Group Member |
| GroupsApi | getGroupMembers | GET /groups/{groupId}/members | List Group Members |
| GroupsApi | getGroupPermissions | GET /groups/{groupId}/permissions | List Group Permissions |
| GroupsApi | getGroupPosts | GET /groups/{groupId}/posts | Get posts from a Group |
| GroupsApi | getGroupRequests | GET /groups/{groupId}/requests | Get Group Join Requests |
| GroupsApi | getGroupRoleTemplates | GET /groups/roleTemplates | Get Group Role Templates |
| GroupsApi | getGroupRoles | GET /groups/{groupId}/roles | Get Group Roles |
| GroupsApi | getGroupTransferability | GET /groups/{groupId}/transfer | Get Group Transferability |
| GroupsApi | initiateOrAcceptGroupTransfer | POST /groups/{groupId}/transfer | Initiate or Accept Group Transfer |
| GroupsApi | joinGroup | POST /groups/{groupId}/join | Join Group |
| GroupsApi | kickGroupMember | DELETE /groups/{groupId}/members/{userId} | Kick Group Member |
| GroupsApi | leaveGroup | POST /groups/{groupId}/leave | Leave Group |
| GroupsApi | removeGroupMemberRole | DELETE /groups/{groupId}/members/{userId}/roles/{groupRoleId} | Remove Role from GroupMember |
| GroupsApi | respondGroupJoinRequest | PUT /groups/{groupId}/requests/{userId} | Respond Group Join request |
| GroupsApi | searchGroupMembers | GET /groups/{groupId}/members/search | Search Group Members |
| GroupsApi | searchGroups | GET /groups | Search Group |
| GroupsApi | unbanGroupMember | DELETE /groups/{groupId}/bans/{userId} | Unban Group Member |
| GroupsApi | updateGroup | PUT /groups/{groupId} | Update Group |
| GroupsApi | updateGroupGallery | PUT /groups/{groupId}/galleries/{groupGalleryId} | Update Group Gallery |
| GroupsApi | updateGroupMember | PUT /groups/{groupId}/members/{userId} | Update Group Member |
| GroupsApi | updateGroupPost | PUT /groups/{groupId}/posts/{notificationId} | Edits a Group post |
| GroupsApi | updateGroupRepresentation | PUT /groups/{groupId}/representation | Update Group Representation |
| GroupsApi | updateGroupRole | PUT /groups/{groupId}/roles/{groupRoleId} | Update Group Role |
| InstancesApi | closeInstance | DELETE /instances/{worldId}:{instanceId} | Close Instance |
| InstancesApi | createInstance | POST /instances | Create Instance |
| InstancesApi | getInstance | GET /instances/{worldId}:{instanceId} | Get Instance |
| InstancesApi | getInstanceByShortName | GET /instances/s/{shortName} | Get Instance By Short Name |
| InstancesApi | getRecentLocations | GET /instances/recent | List Recent Locations |
| InstancesApi | getShortName | GET /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name |
| InventoryApi | consumeOwnInventoryItem | PUT /inventory/{inventoryItemId}/consume | Consume Own Inventory Item |
| InventoryApi | deleteOwnInventoryItem | DELETE /inventory/{inventoryItemId} | Delete Own Inventory Item |
| InventoryApi | equipOwnInventoryItem | PUT /inventory/{inventoryItemId}/equip | Equip Own Inventory Item |
| InventoryApi | getInventory | GET /inventory | Get Inventory |
| InventoryApi | getInventoryCollections | GET /inventory/collections | List Inventory Collections |
| InventoryApi | getInventoryDrops | GET /inventory/drops | List Inventory Drops |
| InventoryApi | getInventoryTemplate | GET /inventory/template/{inventoryTemplateId} | Get Inventory Template |
| InventoryApi | getOwnInventoryItem | GET /inventory/{inventoryItemId} | Get Own Inventory Item |
| InventoryApi | getUserInventoryItem | GET /user/{userId}/inventory/{inventoryItemId} | Get User Inventory Item |
| InventoryApi | shareInventoryItemDirect | POST /inventory/cloning/direct | Share Inventory Item Direct |
| InventoryApi | shareInventoryItemPedestal | GET /inventory/cloning/pedestal | Share Inventory Item by Pedestal |
| InventoryApi | spawnInventoryItem | GET /inventory/spawn | Spawn Inventory Item |
| InventoryApi | unequipOwnInventorySlot | DELETE /inventory/{inventoryItemId}/equip | Unequip Own Inventory Slot |
| InventoryApi | updateOwnInventoryItem | PUT /inventory/{inventoryItemId} | Update Own Inventory Item |
| InviteApi | getInviteMessage | GET /message/{userId}/{messageType}/{slot} | Get Invite Message |
| InviteApi | getInviteMessages | GET /message/{userId}/{messageType} | List Invite Messages |
| InviteApi | inviteMyselfTo | POST /invite/myself/to/{worldId}:{instanceId} | Invite Myself To Instance |
| InviteApi | inviteUser | POST /invite/{userId} | Invite User |
| InviteApi | inviteUserWithPhoto | POST /invite/{userId}/photo | Invite User with photo |
| InviteApi | requestInvite | POST /requestInvite/{userId} | Request Invite |
| InviteApi | requestInviteWithPhoto | POST /requestInvite/{userId}/photo | Request Invite with photo |
| InviteApi | resetInviteMessage | DELETE /message/{userId}/{messageType}/{slot} | Reset Invite Message |
| InviteApi | respondInvite | POST /invite/{notificationId}/response | Respond Invite |
| InviteApi | respondInviteWithPhoto | POST /invite/{notificationId}/response/photo | Respond Invite with photo |
| InviteApi | updateInviteMessage | PUT /message/{userId}/{messageType}/{slot} | Update Invite Message |
| JamsApi | getJam | GET /jams/{jamId} | Show jam information |
| JamsApi | getJamSubmissions | GET /jams/{jamId}/submissions | Show jam submissions |
| JamsApi | getJams | GET /jams | Show jams list |
| MiscellaneousApi | getAssignedPermissions | GET /auth/permissions | Get Assigned Permissions |
| MiscellaneousApi | getCSS | GET /css/app.css | Download CSS |
| MiscellaneousApi | getConfig | GET /config | Fetch API Config |
| MiscellaneousApi | getCurrentOnlineUsers | GET /visits | Current Online Users |
| MiscellaneousApi | getHealth | GET /health | Check API Health |
| MiscellaneousApi | getInfoPush | GET /infoPush | Show Information Notices |
| MiscellaneousApi | getJavaScript | GET /js/app.js | Download JavaScript |
| MiscellaneousApi | getPermission | GET /permissions/{permissionId} | Get Permission |
| MiscellaneousApi | getSystemTime | GET /time | Current System Time |
| NotificationsApi | acceptFriendRequest | PUT /auth/user/notifications/{notificationId}/accept | Accept Friend Request |
| NotificationsApi | acknowledgeNotificationV2 | POST /notifications/{notificationId}/see | Acknowledge NotificationV2 |
| NotificationsApi | clearNotifications | PUT /auth/user/notifications/clear | Clear All Notifications |
| NotificationsApi | deleteAllNotificationV2s | DELETE /notifications | Delete All NotificationV2s |
| NotificationsApi | deleteNotification | PUT /auth/user/notifications/{notificationId}/hide | Delete Notification |
| NotificationsApi | deleteNotificationV2 | DELETE /notifications/{notificationId} | Delete NotificationV2 |
| NotificationsApi | getNotification | GET /auth/user/notifications/{notificationId} | Show notification |
| NotificationsApi | getNotificationV2 | GET /notifications/{notificationId} | Get NotificationV2 |
| NotificationsApi | getNotificationV2s | GET /notifications | List NotificationV2s |
| NotificationsApi | getNotifications | GET /auth/user/notifications | List Notifications |
| NotificationsApi | markNotificationAsRead | PUT /auth/user/notifications/{notificationId}/see | Mark Notification As Read |
| NotificationsApi | replyNotificationV2 | POST /notifications/{notificationId}/reply | Reply NotificationV2 |
| NotificationsApi | respondNotificationV2 | POST /notifications/{notificationId}/respond | Respond NotificationV2 |
| PlayermoderationApi | clearAllPlayerModerations | DELETE /auth/user/playermoderations | Clear All Player Moderations |
| PlayermoderationApi | getPlayerModerations | GET /auth/user/playermoderations | Search Player Moderations |
| PlayermoderationApi | moderateUser | POST /auth/user/playermoderations | Moderate User |
| PlayermoderationApi | unmoderateUser | PUT /auth/user/unplayermoderate | Unmoderate User |
| PrintsApi | deletePrint | DELETE /prints/{printId} | Delete Print |
| PrintsApi | editPrint | POST /prints/{printId} | Edit Print |
| PrintsApi | getPrint | GET /prints/{printId} | Get Print |
| PrintsApi | getUserPrints | GET /prints/user/{userId} | Get Own Prints |
| PrintsApi | uploadPrint | POST /prints | Upload Print |
| PropsApi | createProp | POST /props | Create Prop |
| PropsApi | deleteProp | DELETE /props/{propId} | Delete Prop |
| PropsApi | getProp | GET /props/{propId} | Get Prop |
| PropsApi | getPropPublishStatus | GET /props/{propId}/publish | Get Prop Publish Status |
| PropsApi | listProps | GET /props | List Props |
| PropsApi | publishProp | PUT /props/{propId}/publish | Publish Prop |
| PropsApi | unpublishProp | DELETE /props/{propId}/publish | Unpublish Prop |
| PropsApi | updateProp | PUT /props/{propId} | Update Prop |
| UsersApi | addTags | POST /users/{userId}/addTags | Add User Tags |
| UsersApi | checkUserPersistenceExists | GET /users/{userId}/{worldId}/persist/exists | Check User Persistence Exists |
| UsersApi | deleteAllUserPersistenceData | DELETE /users/{userId}/persist | Delete All User Persistence Data |
| UsersApi | deleteUserPersistence | DELETE /users/{userId}/{worldId}/persist | Delete User Persistence |
| UsersApi | getBlockedGroups | GET /users/{userId}/groups/userblocked | Get User Group Blocks |
| UsersApi | getInvitedGroups | GET /users/{userId}/groups/invited | Get User Group Invited |
| UsersApi | getMutualFriends | GET /users/{userId}/mutuals/friends | Get User Mutual Friends |
| UsersApi | getMutualGroups | GET /users/{userId}/mutuals/groups | Get User Mutual Groups |
| UsersApi | getMutuals | GET /users/{userId}/mutuals | Get User Mutuals |
| UsersApi | getUser | GET /users/{userId} | Get User by ID |
| UsersApi | getUserAllGroupPermissions | GET /users/{userId}/groups/permissions | Get user's permissions for all joined groups. |
| UsersApi | getUserByName | GET /users/{username}/name | Get User by Username |
| UsersApi | getUserFeedback | GET /users/{userId}/feedback | Get User Feedback |
| UsersApi | getUserGroupInstances | GET /users/{userId}/instances/groups | Get User Group Instances |
| UsersApi | getUserGroupInstancesForGroup | GET /users/{userId}/instances/groups/{groupId} | Get User Group Instances for a specific Group |
| UsersApi | getUserGroupRequests | GET /users/{userId}/groups/requested | Get User Group Requests |
| UsersApi | getUserGroups | GET /users/{userId}/groups | Get User Groups |
| UsersApi | getUserNote | GET /userNotes/{userNoteId} | Get User Note |
| UsersApi | getUserNotes | GET /userNotes | Get User Notes |
| UsersApi | getUserRepresentedGroup | GET /users/{userId}/groups/represented | Get user's current represented group |
| UsersApi | removeTags | POST /users/{userId}/removeTags | Remove User Tags |
| UsersApi | searchUsers | GET /users | Search All Users |
| UsersApi | updateBadge | PUT /users/{userId}/badges/{badgeId} | Update User Badge |
| UsersApi | updateUser | PUT /users/{userId} | Update User Info |
| UsersApi | updateUserNote | POST /userNotes | Update User Note |
| WorldsApi | checkUserPersistenceExists | GET /users/{userId}/{worldId}/persist/exists | Check User Persistence Exists |
| WorldsApi | createWorld | POST /worlds | Create World |
| WorldsApi | deleteAllUserPersistenceData | DELETE /users/{userId}/persist | Delete All User Persistence Data |
| WorldsApi | deleteUserPersistence | DELETE /users/{userId}/{worldId}/persist | Delete User Persistence |
| WorldsApi | deleteWorld | DELETE /worlds/{worldId} | Delete World |
| WorldsApi | getActiveWorlds | GET /worlds/active | List Active Worlds |
| WorldsApi | getFavoritedWorlds | GET /worlds/favorites | List Favorited Worlds |
| WorldsApi | getRecentWorlds | GET /worlds/recent | List Recent Worlds |
| WorldsApi | getWorld | GET /worlds/{worldId} | Get World by ID |
| WorldsApi | getWorldInstance | GET /worlds/{worldId}/{instanceId} | Get World Instance |
| WorldsApi | getWorldMetadata | GET /worlds/{worldId}/metadata | Get World Metadata |
| WorldsApi | getWorldPublishStatus | GET /worlds/{worldId}/publish | Get World Publish Status |
| WorldsApi | publishWorld | PUT /worlds/{worldId}/publish | Publish World |
| WorldsApi | searchWorlds | GET /worlds | Search All Worlds |
| WorldsApi | unpublishWorld | DELETE /worlds/{worldId}/publish | Unpublish World |
| WorldsApi | updateWorld | PUT /worlds/{worldId} | Update World |
Documentation for Models
- APIConfig
- APIConfigAnnouncement
- APIConfigAudioConfig
- APIConfigConstants
- APIConfigConstants_GROUPS
- APIConfigConstants_INSTANCE
- APIConfigConstants_INSTANCE_POPULATION_BRACKETS
- APIConfigConstants_INSTANCE_POPULATION_BRACKETS_CROWDED
- APIConfigConstants_INSTANCE_POPULATION_BRACKETS_FEW
- APIConfigConstants_INSTANCE_POPULATION_BRACKETS_MANY
- APIConfigConstants_LANGUAGE
- APIConfigDownloadURLList
- APIConfigEvents
- APIConfig_accessLogsUrls
- APIConfig_avatarPerfLimiter
- APIConfig_iosVersion
- APIConfig_minSupportedClientBuildNumber
- APIConfig_offlineAnalysis
- APIHealth
- AccountDeletionLog
- AddGroupGalleryImageRequest
- AdminAssetBundle
- AdminUnityPackage
- Agreement
- AgreementRequest
- AgreementStatus
- Avatar
- AvatarModeration
- AvatarModerationCreated
- AvatarStyle
- Avatar_performance
- Avatar_publishedListings_inner
- Avatar_styles
- Avatar_unityPackageUrlObject
- Badge
- Balance
- BanGroupMemberRequest
- BoopRequest
- CalendarEvent
- CalendarEventDiscovery
- CalendarEvent_userInterest
- ChangeUserTagsRequest
- CreateAvatarModerationRequest
- CreateAvatarRequest
- CreateCalendarEventRequest
- CreateFileRequest
- CreateFileVersionRequest
- CreateGroupAnnouncementRequest
- CreateGroupGalleryRequest
- CreateGroupInviteRequest
- CreateGroupPostRequest
- CreateGroupRequest
- CreateGroupRequest_1
- CreateInstanceRequest
- CreatePropRequest
- CreateWorldRequest
- CurrentUser
- CurrentUserPresence
- CurrentUser_platform_history_inner
- DeclineGroupInviteRequest
- Disable2FAResult
- DiscordDetails
- DynamicContentRow
- EconomyAccount
- EquipInventoryItemRequest
- Error
- Favorite
- FavoriteGroup
- FavoriteGroupLimits
- FavoriteLimits
- FavoritedWorld
- Feedback
- File
- FileAnalysis
- FileAnalysisAvatarStats
- FileData
- FileUploadURL
- FileVersion
- FileVersionUploadStatus
- FinishFileDataUploadRequest
- FollowCalendarEventRequest
- FriendStatus
- Group
- GroupAnnouncement
- GroupAuditLogEntry
- GroupGallery
- GroupGalleryFileOrder
- GroupGalleryFileOrderRequest
- GroupGalleryImage
- GroupInstance
- GroupMember
- GroupMemberLimitedUser
- GroupMyMember
- GroupPermission
- GroupPost
- GroupRole
- GroupRoleTemplateValues
- GroupRoleTemplateValues_roles
- GroupTransferable
- GroupTransferable_requirements
- InfoPush
- InfoPushData
- InfoPushDataArticle
- InfoPushDataArticleContent
- InfoPushDataClickable
- Instance
- InstanceContentSettings
- InstancePlatforms
- InstanceShortNameResponse
- Inventory
- InventoryConsumptionResults
- InventoryDefaultAttributes_value
- InventoryDefaultAttributes_value_validator
- InventoryDrop
- InventoryItem
- InventoryMetadata
- InventoryNotificationDetails
- InventorySpawn
- InventoryTemplate
- InventoryUserAttributes
- InviteMessage
- InviteRequest
- InviteResponse
- Jam
- Jam_stateChangeDates
- JoinGroupRequest
- License
- LicenseGroup
- LimitedGroup
- LimitedUnityPackage
- LimitedUserFriend
- LimitedUserGroups
- LimitedUserInstance
- LimitedUserSearch
- LimitedWorld
- Listing
- ModerateUserRequest
- ModerationReport
- MutualFriend
- Mutuals
- Notification
- NotificationDetailInvite
- NotificationDetailInviteResponse
- NotificationDetailRequestInvite
- NotificationDetailRequestInviteResponse
- NotificationDetailVoteToKick
- NotificationV2
- NotificationV2DetailsBoop
- NotificationV2Response
- OkStatus
- OkStatus2
- PaginatedCalendarEventList
- PaginatedGroupAuditLogEntryList
- PaginatedModerationReportList
- PastDisplayName
- Pending2FAResult
- PerformanceLimiterInfo
- Permission
- Permission_data
- PlatformBuildInfo
- PlayerModeration
- Print_files
- Product
- ProductListingVariant
- ProductPurchase
- ProductPurchase_purchaseContext
- Prop
- PropPublishStatus
- PropUnityPackage
- PurchaseProductListingRequest
- RegisterUserAccountRequest
- ReportCategory
- ReportReason
- RepresentedGroup
- RequestInviteRequest
- RespondGroupJoinRequest
- RespondNotificationV2Request
- Response
- SentNotification
- ServiceQueueStats
- ServiceStatus
- ShareInventoryItemDirectRequest
- Store
- StoreShelf
- Submission
- SubmitModerationReportRequest
- SubmitModerationReportRequest_details
- Subscription
- Success
- SuccessFlag
- TiliaStatus
- TiliaTOS
- TokenBundle
- Transaction
- TransactionAgreement
- TransactionSteamInfo
- TransactionSteamWalletInfo
- TransferGroupRequest
- TwoFactorAuthCode
- TwoFactorEmailCode
- TwoFactorRecoveryCodes
- TwoFactorRecoveryCodes_otp_inner
- UnityPackage
- UpdateAssetReviewNotesRequest
- UpdateAvatarRequest
- UpdateCalendarEventRequest
- UpdateFavoriteGroupRequest
- UpdateGroupGalleryRequest
- UpdateGroupMemberRequest
- UpdateGroupRequest
- UpdateGroupRoleRequest
- UpdateInventoryItemRequest
- UpdateInviteMessageRequest
- UpdatePropRequest
- UpdateTiliaTOSRequest
- UpdateUserBadgeRequest
- UpdateUserNoteRequest
- UpdateUserRequest
- UpdateWorldRequest
- User
- UserCreditsEligible
- UserExists
- UserNote
- UserNote_targetUser
- UserSubscription
- UserSubscriptionEligible
- Verify2FAEmailCodeResult
- Verify2FAResult
- VerifyAuthTokenResult
- World
- WorldMetadata
- WorldPublishStatus
- addFavorite_request
- createPermission_request
- getGroupPosts_200_response
- getUserGroupInstances_200_response
- searchGroupMembers_200_response
- updateGroupRepresentation_request
- updatePermission_request
Documentation for Authorization
authCookie
- Type: API key
- API key parameter name: auth
- Location:
authHeader
- Type: HTTP basic authentication
twoFactorAuthCookie
- Type: API key
- API key parameter name: twoFactorAuth
- Location: