Creator Hub
Dashboard
Learn
Store
Talent
Forum
Roadmap
Log In
Cloud
Reference
Guides
Cloud
/
Reference
/
Users and groups
English
Feedback
Friends v1
Base URL
https://friends.roblox.com
JSON
Download
Friends
GET
/v1
/metadata
GET
/v1
/my
/friends
/count
Get the number of friends a user has
GET
/v1
/my
/friends
/requests
Get all users that friend requests with targetUserId using exclusive start paging
GET
/v1
/my
/new-friend-requests
/count
GET
/v1
/user
/friend-requests
/count
Return the number of pending friend requests.
GET
/v1
/users
/{userId}
/friends
Get list of all friends for the specified user.
GET
/v1
/users
/{userId}
/friends
/count
Get the number of friends a user has
GET
/v1
/users
/{userId}
/friends
/find
Get a paginated list of all friends for the specified user.
GET
/v1
/users
/{userId}
/friends
/inactive
Get list of inactive friends for the specified user.
GET
/v1
/users
/{userId}
/friends
/online
Get list of all online friends for the specified user.
GET
/v1
/users
/{userId}
/friends
/search
Search for friends by name using a text query.
GET
/v1
/users
/{userId}
/friends
/statuses
Gets a list of friend statuses of specified users against the specified user.
POST
/v1
/contacts
/{targetContactId}
/request-friendship
Send a contact friend request to target user
POST
/v1
/user
/{userId}
/multiget-are-friends
Check if the requesting user is friends with the specified users.
POST
/v1
/user
/friend-requests
/decline-all
Decline all pending friend requests for the authenticated user.
POST
/v1
/users
/{requesterUserId}
/accept-friend-request
Accept a friend request.
POST
/v1
/users
/{requesterUserId}
/decline-friend-request
Decline a friend request.
POST
/v1
/users
/{senderUserId}
/accept-friend-request-with-token
Accept a friend request with an Off Network Friending token.
POST
/v1
/users
/{targetUserId}
/request-friendship
Send a friend request to target user
POST
/v1
/users
/{targetUserId}
/unfriend
Unfriend a user
DELETE
/v1
/my
/new-friend-requests
Followings
GET
/v1
/users
/{targetUserId}
/followers
Get all users that follow user with targetUserId in page response format
GET
/v1
/users
/{targetUserId}
/followers
/count
Get the number of following a user has
GET
/v1
/users
/{targetUserId}
/followings
Get all users that user with targetUserId is following in page response format
GET
/v1
/users
/{targetUserId}
/followings
/count
Get the number of following a user has
POST
/v1
/user
/following-exists
Returns whether or not the current user is following each userId in a list of userIds
POST
/v1
/users
/{targetUserId}
/follow
Creates the following between a user and user with targetUserId
POST
/v1
/users
/{targetUserId}
/unfollow
Deletes the following between a user and user with targetUserId
Models
Models
Roblox.Friends.Api.CaptchaStatusResponseModel
Roblox.Friends.Api.FollowCountResponse
Roblox.Friends.Api.FollowingExistsRequestModel
Roblox.Friends.Api.FriendRequest
Roblox.Friends.Api.FriendRequestResponse
Roblox.Friends.Api.FriendStatusResponse
Roblox.Friends.Api.FriendsCountResponse
Roblox.Friends.Api.FriendshipRequestModel
Roblox.Friends.Api.Models.Request.FriendingTokenRequestModel
Roblox.Friends.Api.Models.Response.ClearNewFriendRequestResponse
Roblox.Friends.Api.Models.Response.DeclineAllFriendRequestsResponse
Roblox.Friends.Api.Models.Response.FollowingExistsResponse
Roblox.Friends.Api.Models.Response.FollowingExistsResponseModel
Roblox.Friends.Api.Models.Response.FriendResponse
Roblox.Friends.Api.Models.Response.FriendsPageMetadataResponse
Roblox.Friends.Api.Models.Response.NewFriendRequestsCountResponse
Roblox.Friends.Api.Models.Response.UserPresenceResponse
Roblox.Friends.Api.Models.Response.UserPresenceResponseModel
Roblox.Friends.Api.Models.Response.UserResponse
Roblox.Friends.Api.MultigetAreFriendsRequestModel
Roblox.Friends.Api.MultigetAreFriendsResponse
Roblox.Friends.Api.PendingFriendRequestCountModel
Roblox.Paging.CursoredPagedResult[Roblox.Friends.Api.Models.Response.FriendResponse]
Roblox.Paging.ExclusiveStartKeyCursor[System.String]
Roblox.Platform.Core.ExclusiveStartPaging.IExclusiveStartKeyInfo[Roblox.Web.Friends.FriendRequestsPlatformExclusiveStartKey]
Roblox.Platform.Core.ExclusiveStartPaging.IExclusiveStartKeyInfo[System.Int64]
Roblox.Web.Captcha.Models.Request.CaptchaTokenRequest
Roblox.Web.WebAPI.ApiEmptyResponseModel
Roblox.Web.WebAPI.ExclusiveStartRequest[Roblox.Web.Friends.FriendRequestsPlatformExclusiveStartKey]
Roblox.Web.WebAPI.ExclusiveStartRequest[System.Int64]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Friends.Api.FriendStatusResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Friends.Api.Models.Response.UserPresenceResponse]
Roblox.Web.WebAPI.Models.ApiArrayResponse[Roblox.Friends.Api.Models.Response.UserResponse]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Friends.Api.FriendRequestResponse]
Roblox.Web.WebAPI.Models.ApiPageResponse[Roblox.Friends.Api.Models.Response.UserResponse]
System.ValueTuple[Roblox.Web.WebAPI.ExclusiveStartRequest[System.Int64],Roblox.Paging.ExclusiveStartKeyCursor[System.String]]