VRChatBackendDocs/Apis/FavoritesApi.md

FavoritesApi

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

Method	HTTP request	Description
addFavorite	POST /favorites	Add Favorite
clearFavoriteGroup	DELETE /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId}	Clear Favorite Group
getFavoriteGroup	GET /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId}	Show Favorite Group
getFavoriteGroups	GET /favorite/groups	List Favorite Groups
getFavoriteLimits	GET /auth/user/favoritelimits	Get Favorite Limits
getFavorites	GET /favorites	List Favorites
removeFavorite	DELETE /favorites/{favoriteId}	Remove Favorite
updateFavoriteGroup	PUT /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId}	Update Favorite Group

addFavorite

Favorite addFavorite(addFavorite_request)

Add Favorite

Add a new favorite.  Friend groups are named `group_0` through `group_3`. Avatar and World groups are named `avatars1` to `avatars4` and `worlds1` to `worlds4`.  You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides.

Parameters

Name	Type	Description	Notes
addFavorite_request	addFavorite_request		[optional]

Return type

Favorite

Authorization

authCookie

HTTP request headers

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

clearFavoriteGroup

Success clearFavoriteGroup(favoriteGroupType, favoriteGroupName, userId)

Clear Favorite Group

Clear ALL contents of a specific favorite group.

Parameters

Name	Type	Description	Notes
favoriteGroupType	String	The type of group to fetch, must be a valid FavoriteType.	[default to null] [enum: avatar, friend, world]
favoriteGroupName	String	The name of the group to fetch, must be a name of a FavoriteGroup.	[default to null]
userId	String	Must be a valid user ID.	[default to null]

Return type

Success

Authorization

authCookie

HTTP request headers

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

getFavoriteGroup

FavoriteGroup getFavoriteGroup(favoriteGroupType, favoriteGroupName, userId)

Show Favorite Group

Fetch information about a specific favorite group.

Parameters

Name	Type	Description	Notes
favoriteGroupType	String	The type of group to fetch, must be a valid FavoriteType.	[default to null] [enum: avatar, friend, world]
favoriteGroupName	String	The name of the group to fetch, must be a name of a FavoriteGroup.	[default to null]
userId	String	Must be a valid user ID.	[default to null]

Return type

FavoriteGroup

Authorization

authCookie

HTTP request headers

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

getFavoriteGroups

List getFavoriteGroups(n, offset, userId, ownerId)

List Favorite Groups

Return a list of favorite groups owned by a user. Returns the same information as `getFavoriteGroups`.

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]
userId	String	Target user to see information on, admin-only.	[optional] [default to null]
ownerId	String	The owner of whoms favorite groups to return. Must be a UserID.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

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

getFavoriteLimits

FavoriteLimits getFavoriteLimits()

Get Favorite Limits

Return information about a specific Favorite.

Parameters

This endpoint does not need any parameter.

Return type

FavoriteLimits

Authorization

authCookie

HTTP request headers

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

getFavorites

List getFavorites(n, offset, type, tag)

List Favorites

Returns a list of favorites.

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]
type	String	The type of favorites to return, FavoriteType.	[optional] [default to null]
tag	String	Tags to include (comma-separated). Any of the tags needs to be present.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

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

removeFavorite

Success removeFavorite(favoriteId)

Remove Favorite

Remove a favorite from your favorites list.

Parameters

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

Return type

Success

Authorization

authCookie

HTTP request headers

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

updateFavoriteGroup

updateFavoriteGroup(favoriteGroupType, favoriteGroupName, userId, UpdateFavoriteGroupRequest)

Update Favorite Group

Update information about a specific favorite group.

Parameters

Name	Type	Description	Notes
favoriteGroupType	String	The type of group to fetch, must be a valid FavoriteType.	[default to null] [enum: avatar, friend, world]
favoriteGroupName	String	The name of the group to fetch, must be a name of a FavoriteGroup.	[default to null]
userId	String	Must be a valid user ID.	[default to null]
UpdateFavoriteGroupRequest	UpdateFavoriteGroupRequest		[optional]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

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