Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
GET /v1/users/{userId}/friends/statuses — openapi
Gets a list of friend statuses of specified users against the specified user.
Endpoint
Method: GET
Path: /v1/users/{userId}/friends/statuses
Servers:
https://friends.roblox.com
Parameters
| Name | Location | Required | Description |
|---|---|---|---|
| userId | path | true | The user to check the friend statuses against. |
| userIds | query | true |
[
{
"in": "path",
"name": "userId",
"description": "The user to check the friend statuses against.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "userIds",
"description": "",
"required": true,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"format": "int64",
"type": "integer"
}
}
}
]Responses
| Status | Description |
|---|---|
| 200 | OK |
| 400 | 1: The target user is invalid or does not exist. 15: Too many ids. 16: Invalid ids. |
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Friends.Api.FriendStatusResponse_"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Friends.Api.FriendStatusResponse_"
}
}
}
},
"400": {
"description": "1: The target user is invalid or does not exist.\r\n15: Too many ids.\r\n16: Invalid ids."
}
}Authentication
{
"security": [
{},
{
"roblox-legacy-cookie": []
}
],
"securitySchemes": {
"roblox-api-key": {
"type": "apiKey",
"description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
"name": "x-api-key",
"in": "header"
},
"roblox-legacy-cookie": {
"type": "apiKey",
"description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
"in": "cookie",
"name": ".ROBLOSECURITY"
},
"roblox-oauth2": {
"type": "oauth2",
"description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
"tokenUrl": "https://apis.roblox.com/oauth/v1/token",
"refreshUrl": "https://apis.roblox.com/oauth/v1/token",
"scopes": {}
}
}
}
}
}Related Schemas
Complete Operation Definition
{
"tags": [
"Connections",
"Users"
],
"summary": "Gets a list of friend statuses of specified users against the specified user.",
"parameters": [
{
"in": "path",
"name": "userId",
"description": "The user to check the friend statuses against.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "userIds",
"description": "",
"required": true,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"format": "int64",
"type": "integer"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Friends.Api.FriendStatusResponse_"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Friends.Api.FriendStatusResponse_"
}
}
}
},
"400": {
"description": "1: The target user is invalid or does not exist.\r\n15: Too many ids.\r\n16: Invalid ids."
}
},
"servers": [
{
"url": "https://friends.roblox.com"
}
],
"x-roblox-stability": "EXPERIMENTAL",
"x-roblox-engine-usability": {
"apiKeyWithHttpService": false
},
"security": [
{},
{
"roblox-legacy-cookie": []
}
],
"externalDocs": {
"url": "https://create.roblox.com/docs/cloud/reference/features/friends#friends_get_v1_users__userId__friends_statuses"
}
}