ExilProductions/VRChatBackendDocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
aa707d1deb9b3d436e6dab60d6d4eeb1406c0478
VRChatBackendDocs/Apis/UsersApi.md
ExilProductions aa707d1deb add subdir
2026-02-15 17:39:26 +01:00

730 lines
20 KiB
Markdown
Raw Blame History

# UsersApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**addTags**](UsersApi.md#addTags) | **POST** /users/{userId}/addTags | Add User Tags |
| [**checkUserPersistenceExists**](UsersApi.md#checkUserPersistenceExists) | **GET** /users/{userId}/{worldId}/persist/exists | Check User Persistence Exists |
| [**deleteAllUserPersistenceData**](UsersApi.md#deleteAllUserPersistenceData) | **DELETE** /users/{userId}/persist | Delete All User Persistence Data |
| [**deleteUserPersistence**](UsersApi.md#deleteUserPersistence) | **DELETE** /users/{userId}/{worldId}/persist | Delete User Persistence |
| [**getBlockedGroups**](UsersApi.md#getBlockedGroups) | **GET** /users/{userId}/groups/userblocked | Get User Group Blocks |
| [**getInvitedGroups**](UsersApi.md#getInvitedGroups) | **GET** /users/{userId}/groups/invited | Get User Group Invited |
| [**getMutualFriends**](UsersApi.md#getMutualFriends) | **GET** /users/{userId}/mutuals/friends | Get User Mutual Friends |
| [**getMutualGroups**](UsersApi.md#getMutualGroups) | **GET** /users/{userId}/mutuals/groups | Get User Mutual Groups |
| [**getMutuals**](UsersApi.md#getMutuals) | **GET** /users/{userId}/mutuals | Get User Mutuals |
| [**getUser**](UsersApi.md#getUser) | **GET** /users/{userId} | Get User by ID |
| [**getUserAllGroupPermissions**](UsersApi.md#getUserAllGroupPermissions) | **GET** /users/{userId}/groups/permissions | Get user's permissions for all joined groups. |
| [**getUserByName**](UsersApi.md#getUserByName) | **GET** /users/{username}/name | Get User by Username |
| [**getUserFeedback**](UsersApi.md#getUserFeedback) | **GET** /users/{userId}/feedback | Get User Feedback |
| [**getUserGroupInstances**](UsersApi.md#getUserGroupInstances) | **GET** /users/{userId}/instances/groups | Get User Group Instances |
| [**getUserGroupInstancesForGroup**](UsersApi.md#getUserGroupInstancesForGroup) | **GET** /users/{userId}/instances/groups/{groupId} | Get User Group Instances for a specific Group |
| [**getUserGroupRequests**](UsersApi.md#getUserGroupRequests) | **GET** /users/{userId}/groups/requested | Get User Group Requests |
| [**getUserGroups**](UsersApi.md#getUserGroups) | **GET** /users/{userId}/groups | Get User Groups |
| [**getUserNote**](UsersApi.md#getUserNote) | **GET** /userNotes/{userNoteId} | Get User Note |
| [**getUserNotes**](UsersApi.md#getUserNotes) | **GET** /userNotes | Get User Notes |
| [**getUserRepresentedGroup**](UsersApi.md#getUserRepresentedGroup) | **GET** /users/{userId}/groups/represented | Get user's current represented group |
| [**removeTags**](UsersApi.md#removeTags) | **POST** /users/{userId}/removeTags | Remove User Tags |
| [**searchUsers**](UsersApi.md#searchUsers) | **GET** /users | Search All Users |
| [**updateBadge**](UsersApi.md#updateBadge) | **PUT** /users/{userId}/badges/{badgeId} | Update User Badge |
| [**updateUser**](UsersApi.md#updateUser) | **PUT** /users/{userId} | Update User Info |
| [**updateUserNote**](UsersApi.md#updateUserNote) | **POST** /userNotes | Update User Note |
<a name="addTags"></a>
# **addTags**
> CurrentUser addTags(userId, ChangeUserTagsRequest)
Add User Tags
Adds tags to the user&#39;s profile
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **ChangeUserTagsRequest** | [**ChangeUserTagsRequest**](../Models/ChangeUserTagsRequest.md)| | |
### Return type
[**CurrentUser**](../Models/CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="checkUserPersistenceExists"></a>
# **checkUserPersistenceExists**
> checkUserPersistenceExists(userId, worldId)
Check User Persistence Exists
Checks whether the user has persistence data for a given world
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteAllUserPersistenceData"></a>
# **deleteAllUserPersistenceData**
> deleteAllUserPersistenceData(userId)
Delete All User Persistence Data
Deletes all of the user&#39;s persistence data for every world.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteUserPersistence"></a>
# **deleteUserPersistence**
> deleteUserPersistence(userId, worldId)
Delete User Persistence
Deletes the user&#39;s persistence data for a given world
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **worldId** | **String**| Must be a valid world ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getBlockedGroups"></a>
# **getBlockedGroups**
> List getBlockedGroups(userId)
Get User Group Blocks
Returns a list of Groups the user has blocked.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**List**](../Models/Group.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInvitedGroups"></a>
# **getInvitedGroups**
> List getInvitedGroups(userId)
Get User Group Invited
Returns a list of Groups the user has been invited to.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**List**](../Models/Group.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getMutualFriends"></a>
# **getMutualFriends**
> List getMutualFriends(userId, n, offset)
Get User Mutual Friends
Gets a list of mutual friends between the logged in user and the specified user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/MutualFriend.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getMutualGroups"></a>
# **getMutualGroups**
> List getMutualGroups(userId, n, offset)
Get User Mutual Groups
Gets a list of mutual groups between the logged in user and the specified user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/LimitedUserGroups.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getMutuals"></a>
# **getMutuals**
> Mutuals getMutuals(userId)
Get User Mutuals
Gets the counts of mutuals between the logged in user and the specified user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Mutuals**](../Models/Mutuals.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUser"></a>
# **getUser**
> User getUser(userId)
Get User by ID
Get public user information about a specific user using their ID.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**User**](../Models/User.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserAllGroupPermissions"></a>
# **getUserAllGroupPermissions**
> Map getUserAllGroupPermissions(userId, groupIds)
Get user&#39;s permissions for all joined groups.
Returns a mapping of GroupIDs to arrays of GroupPermissions.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **groupIds** | **String**| Comma-separated (no spaces!) list of GroupIDs to retrieve permissions for. | [optional] [default to null] |
### Return type
[**Map**](../Models/array.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserByName"></a>
# **getUserByName**
> User getUserByName(username)
Get User by Username
~~Get public user information about a specific user using their name.~~ **DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429). This endpoint now require Admin Credentials.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **username** | **String**| Username of the user | [default to null] |
### Return type
[**User**](../Models/User.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserFeedback"></a>
# **getUserFeedback**
> List getUserFeedback(userId, contentId, n, offset)
Get User Feedback
Get user&#39;s submitted feedback
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **contentId** | **Boolean**| Filter for users&#39; previously submitted feedback, e.g., a groupId, userId, avatarId, etc. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/Feedback.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserGroupInstances"></a>
# **getUserGroupInstances**
> getUserGroupInstances_200_response getUserGroupInstances(userId)
Get User Group Instances
Returns a list of group instances for a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**getUserGroupInstances_200_response**](../Models/getUserGroupInstances_200_response.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserGroupInstancesForGroup"></a>
# **getUserGroupInstancesForGroup**
> getUserGroupInstances_200_response getUserGroupInstancesForGroup(userId, groupId)
Get User Group Instances for a specific Group
Returns a list of a group&#39;s instances for a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**getUserGroupInstances_200_response**](../Models/getUserGroupInstances_200_response.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserGroupRequests"></a>
# **getUserGroupRequests**
> List getUserGroupRequests(userId)
Get User Group Requests
Returns a list of Groups the user has requested to be invited into.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**List**](../Models/Group.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserGroups"></a>
# **getUserGroups**
> List getUserGroups(userId)
Get User Groups
Get user&#39;s public groups
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**List**](../Models/LimitedUserGroups.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserNote"></a>
# **getUserNote**
> UserNote getUserNote(userNoteId)
Get User Note
Get a particular user note
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userNoteId** | **String**| Must be a valid user note ID. | [default to null] |
### Return type
[**UserNote**](../Models/UserNote.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserNotes"></a>
# **getUserNotes**
> List getUserNotes(n, offset)
Get User Notes
Get recently updated user notes
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/UserNote.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserRepresentedGroup"></a>
# **getUserRepresentedGroup**
> RepresentedGroup getUserRepresentedGroup(userId)
Get user&#39;s current represented group
Returns the current group that the user is currently representing
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**RepresentedGroup**](../Models/RepresentedGroup.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="removeTags"></a>
# **removeTags**
> CurrentUser removeTags(userId, ChangeUserTagsRequest)
Remove User Tags
Removes tags from the user&#39;s profile
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **ChangeUserTagsRequest** | [**ChangeUserTagsRequest**](../Models/ChangeUserTagsRequest.md)| | |
### Return type
[**CurrentUser**](../Models/CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="searchUsers"></a>
# **searchUsers**
> List searchUsers(search, developerType, n, offset, isInternalVariant)
Search All Users
Search and list any users by text query
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **search** | **String**| Searches by &#x60;displayName&#x60;. Will return empty array if search query is empty or missing. | [optional] [default to null] |
| **developerType** | **String**| Active user by developer type, none for normal users and internal for moderators | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **isInternalVariant** | **Boolean**| Not quite sure what this actually does (exists on the website but doesn&#39;t seem to be used) | [optional] [default to null] |
### Return type
[**List**](../Models/LimitedUserSearch.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateBadge"></a>
# **updateBadge**
> updateBadge(userId, badgeId, UpdateUserBadgeRequest)
Update User Badge
Updates a user&#39;s badge
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **badgeId** | **String**| Must be a valid badge ID. | [default to null] |
| **UpdateUserBadgeRequest** | [**UpdateUserBadgeRequest**](../Models/UpdateUserBadgeRequest.md)| | |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateUser"></a>
# **updateUser**
> CurrentUser updateUser(userId, UpdateUserRequest)
Update User Info
Update a users information such as the email and birthday.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **UpdateUserRequest** | [**UpdateUserRequest**](../Models/UpdateUserRequest.md)| | [optional] |
### Return type
[**CurrentUser**](../Models/CurrentUser.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateUserNote"></a>
# **updateUserNote**
> UserNote updateUserNote(UpdateUserNoteRequest)
Update User Note
Updates the currently authenticated user&#39;s note on a user
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **UpdateUserNoteRequest** | [**UpdateUserNoteRequest**](../Models/UpdateUserNoteRequest.md)| | |
### Return type
[**UserNote**](../Models/UserNote.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
Reference in New Issue View Git Blame Copy Permalink