VRChatBackendDocs/Apis/UsersApi.md

UsersApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method	HTTP request	Description
addTags	POST /users/{userId}/addTags	Add User Tags
checkUserPersistenceExists	GET /users/{userId}/{worldId}/persist/exists	Check User Persistence Exists
deleteAllUserPersistenceData	DELETE /users/{userId}/persist	Delete All User Persistence Data
deleteUserPersistence	DELETE /users/{userId}/{worldId}/persist	Delete User Persistence
getBlockedGroups	GET /users/{userId}/groups/userblocked	Get User Group Blocks
getInvitedGroups	GET /users/{userId}/groups/invited	Get User Group Invited
getMutualFriends	GET /users/{userId}/mutuals/friends	Get User Mutual Friends
getMutualGroups	GET /users/{userId}/mutuals/groups	Get User Mutual Groups
getMutuals	GET /users/{userId}/mutuals	Get User Mutuals
getUser	GET /users/{userId}	Get User by ID
getUserAllGroupPermissions	GET /users/{userId}/groups/permissions	Get user's permissions for all joined groups.
getUserByName	GET /users/{username}/name	Get User by Username
getUserFeedback	GET /users/{userId}/feedback	Get User Feedback
getUserGroupInstances	GET /users/{userId}/instances/groups	Get User Group Instances
getUserGroupInstancesForGroup	GET /users/{userId}/instances/groups/{groupId}	Get User Group Instances for a specific Group
getUserGroupRequests	GET /users/{userId}/groups/requested	Get User Group Requests
getUserGroups	GET /users/{userId}/groups	Get User Groups
getUserNote	GET /userNotes/{userNoteId}	Get User Note
getUserNotes	GET /userNotes	Get User Notes
getUserRepresentedGroup	GET /users/{userId}/groups/represented	Get user's current represented group
removeTags	POST /users/{userId}/removeTags	Remove User Tags
searchUsers	GET /users	Search All Users
updateBadge	PUT /users/{userId}/badges/{badgeId}	Update User Badge
updateUser	PUT /users/{userId}	Update User Info
updateUserNote	POST /userNotes	Update User Note

addTags

CurrentUser addTags(userId, ChangeUserTagsRequest)

Add User Tags

Adds tags to the user's profile

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
ChangeUserTagsRequest	ChangeUserTagsRequest

Return type

CurrentUser

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

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

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteAllUserPersistenceData

deleteAllUserPersistenceData(userId)

Delete All User Persistence Data

Deletes all of the user'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

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteUserPersistence

deleteUserPersistence(userId, worldId)

Delete User Persistence

Deletes the user'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

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUserAllGroupPermissions

Map getUserAllGroupPermissions(userId, groupIds)

Get user'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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUserFeedback

List getUserFeedback(userId, contentId, n, offset)

Get User Feedback

Get user's submitted feedback

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
contentId	Boolean	Filter for users' 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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUserGroupInstancesForGroup

getUserGroupInstances_200_response getUserGroupInstancesForGroup(userId, groupId)

Get User Group Instances for a specific Group

Returns a list of a group'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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUserGroups

List getUserGroups(userId)

Get User Groups

Get user's public groups

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUserRepresentedGroup

RepresentedGroup getUserRepresentedGroup(userId)

Get user'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

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

removeTags

CurrentUser removeTags(userId, ChangeUserTagsRequest)

Remove User Tags

Removes tags from the user's profile

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
ChangeUserTagsRequest	ChangeUserTagsRequest

Return type

CurrentUser

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

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 `displayName`. 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't seem to be used)	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

updateBadge

updateBadge(userId, badgeId, UpdateUserBadgeRequest)

Update User Badge

Updates a user'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

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

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		[optional]

Return type

CurrentUser

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateUserNote

UserNote updateUserNote(UpdateUserNoteRequest)

Update User Note

Updates the currently authenticated user's note on a user

Parameters

Name	Type	Description	Notes
UpdateUserNoteRequest	UpdateUserNoteRequest

Return type

UserNote

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json