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

243 lines
7.7 KiB
Markdown
Raw Blame History

# FavoritesApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**addFavorite**](FavoritesApi.md#addFavorite) | **POST** /favorites | Add Favorite |
| [**clearFavoriteGroup**](FavoritesApi.md#clearFavoriteGroup) | **DELETE** /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId} | Clear Favorite Group |
| [**getFavoriteGroup**](FavoritesApi.md#getFavoriteGroup) | **GET** /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId} | Show Favorite Group |
| [**getFavoriteGroups**](FavoritesApi.md#getFavoriteGroups) | **GET** /favorite/groups | List Favorite Groups |
| [**getFavoriteLimits**](FavoritesApi.md#getFavoriteLimits) | **GET** /auth/user/favoritelimits | Get Favorite Limits |
| [**getFavorites**](FavoritesApi.md#getFavorites) | **GET** /favorites | List Favorites |
| [**removeFavorite**](FavoritesApi.md#removeFavorite) | **DELETE** /favorites/{favoriteId} | Remove Favorite |
| [**updateFavoriteGroup**](FavoritesApi.md#updateFavoriteGroup) | **PUT** /favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId} | Update Favorite Group |
<a name="addFavorite"></a>
# **addFavorite**
> Favorite addFavorite(addFavorite\_request)
Add Favorite
Add a new favorite. Friend groups are named &#x60;group_0&#x60; through &#x60;group_3&#x60;. Avatar and World groups are named &#x60;avatars1&#x60; to &#x60;avatars4&#x60; and &#x60;worlds1&#x60; to &#x60;worlds4&#x60;. 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**](../Models/addFavorite_request.md)| | [optional] |
### Return type
[**Favorite**](../Models/Favorite.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="clearFavoriteGroup"></a>
# **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**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavoriteGroup"></a>
# **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**](../Models/FavoriteGroup.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavoriteGroups"></a>
# **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 &#x60;getFavoriteGroups&#x60;.
### 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**](../Models/FavoriteGroup.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavoriteLimits"></a>
# **getFavoriteLimits**
> FavoriteLimits getFavoriteLimits()
Get Favorite Limits
Return information about a specific Favorite.
### Parameters
This endpoint does not need any parameter.
### Return type
[**FavoriteLimits**](../Models/FavoriteLimits.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getFavorites"></a>
# **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**](../Models/Favorite.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="removeFavorite"></a>
# **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**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateFavoriteGroup"></a>
# **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**](../Models/UpdateFavoriteGroupRequest.md)| | [optional] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
Reference in New Issue View Git Blame Copy Permalink