4 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GET /v1/my/friends/requests — openapi

Get all users that friend requests with targetUserId using exclusive start paging

Endpoint

Method: GET

Path: /v1/my/friends/requests

Servers:

Parameters

NameLocationRequiredDescription
limitqueryfalseThe number of results per request.
cursorqueryfalseThe paging cursor for the previous or next page.
sessionIdqueryfalseOptional session identifier.
friendRequestSortqueryfalse
uprankUnseenqueryfalseWhether to uprank unseen friend requests and return isUnseen per friend request.
[
  {
    "in": "query",
    "name": "limit",
    "description": "The number of results per request.",
    "schema": {
      "type": "integer",
      "format": "int32",
      "default": 10
    }
  },
  {
    "in": "query",
    "name": "cursor",
    "description": "The paging cursor for the previous or next page.",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "sessionId",
    "description": "Optional session identifier.",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "friendRequestSort",
    "schema": {
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        1,
        2
      ],
      "default": 1
    }
  },
  {
    "in": "query",
    "name": "uprankUnseen",
    "description": "Whether to uprank unseen friend requests and return isUnseen per friend request.",
    "schema": {
      "type": "boolean",
      "default": false
    }
  }
]

Responses

StatusDescription
200OK
4001: The target user is invalid or does not exist. 6: Invalid parameters. 34: Invalid pagination cursor.
4010: Authorization has been denied for this request.
4032: The user is banned from performing operation. 3: The user is blocked from performing this action.
4299: The flood limit has been exceeded.
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Friends.Api.FriendRequestResponse_"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Friends.Api.FriendRequestResponse_"
        }
      }
    }
  },
  "400": {
    "description": "1: The target user is invalid or does not exist.\r\n6: Invalid parameters.\r\n34: Invalid pagination cursor."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "2: The user is banned from performing operation.\r\n3: The user is blocked from performing this action."
  },
  "429": {
    "description": "9: The flood limit has been exceeded."
  }
}

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": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Connections"
  ],
  "summary": "Get all users that friend requests with targetUserId using exclusive start paging",
  "parameters": [
    {
      "in": "query",
      "name": "limit",
      "description": "The number of results per request.",
      "schema": {
        "type": "integer",
        "format": "int32",
        "default": 10
      }
    },
    {
      "in": "query",
      "name": "cursor",
      "description": "The paging cursor for the previous or next page.",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "sessionId",
      "description": "Optional session identifier.",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "friendRequestSort",
      "schema": {
        "type": "integer",
        "format": "int32",
        "enum": [
          0,
          1,
          2
        ],
        "default": 1
      }
    },
    {
      "in": "query",
      "name": "uprankUnseen",
      "description": "Whether to uprank unseen friend requests and return isUnseen per friend request.",
      "schema": {
        "type": "boolean",
        "default": false
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Friends.Api.FriendRequestResponse_"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Friends.Api.FriendRequestResponse_"
          }
        }
      }
    },
    "400": {
      "description": "1: The target user is invalid or does not exist.\r\n6: Invalid parameters.\r\n34: Invalid pagination cursor."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "2: The user is banned from performing operation.\r\n3: The user is blocked from performing this action."
    },
    "429": {
      "description": "9: The flood limit has been exceeded."
    }
  },
  "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_my_friends_requests"
  }
}