VRChatBackendDocs/Apis/FriendsApi.md

FriendsApi

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

Method	HTTP request	Description
boop	POST /users/{userId}/boop	Send Boop
deleteFriendRequest	DELETE /user/{userId}/friendRequest	Delete Friend Request
friend	POST /user/{userId}/friendRequest	Send Friend Request
getFriendStatus	GET /user/{userId}/friendStatus	Check Friend Status
getFriends	GET /auth/user/friends	List Friends
unfriend	DELETE /auth/user/friends/{userId}	Unfriend

boop

Success boop(userId, BoopRequest)

Send Boop

Send a boop to another user.

Parameters

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

Return type

Success

Authorization

authCookie

HTTP request headers

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

deleteFriendRequest

Success deleteFriendRequest(userId)

Delete Friend Request

Deletes an outgoing pending friend request to another user. To delete an incoming friend request, use the `deleteNotification` endpoint instead.

Parameters

Name	Type	Description	Notes
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

friend

Notification friend(userId)

Send Friend Request

Send a friend request to another user.

Parameters

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

Return type

Notification

Authorization

authCookie

HTTP request headers

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

getFriendStatus

FriendStatus getFriendStatus(userId)

Check Friend Status

Retrieve if the user is currently a friend with a given user, if they have an outgoing friend request, and if they have an incoming friend request. The proper way to receive and accept friend request is by checking if the user has an incoming `Notification` of type `friendRequest`, and then accepting that notification.

Parameters

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

Return type

FriendStatus

Authorization

authCookie

HTTP request headers

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

getFriends

List getFriends(offset, n, offline)

List Friends

List information about friends.

Parameters

Name	Type	Description	Notes
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
offline	Boolean	Returns only offline users if true, returns only online and active users if false	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

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

unfriend

Success unfriend(userId)

Unfriend

Unfriend a user by ID.

Parameters

Name	Type	Description	Notes
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