2 min read

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

Roblox.Friends.Api.FriendRequestResponse — openapi

A response model representing a friend request.

Properties

NameTypeRequiredDescription
friendRequest#/components/schemas/Roblox.Friends.Api.FriendRequestfalse
mutualFriendsListarrayfalsemutualFriendsList
hasVerifiedBadgebooleanfalseThe user's verified badge status.
isUnseenbooleanfalseThe user's verified badge status.
descriptionstringfalseThe user description.
createdstringfalseWhen the user signed up.
isBannedbooleanfalseWhether or not the user is banned
externalAppDisplayNamestringfalseUsed when user is logged in from third party app (e.g. QQ) ExternalAppDisplayName is the name used in that app (e.g. QQ nickname)
idintegerfalseThe user Id.
namestringfalseThe user name.
displayNamestringfalseThe user DisplayName.

Complete Schema

{
  "description": "A response model representing a friend request.",
  "type": "object",
  "properties": {
    "friendRequest": {
      "$ref": "#/components/schemas/Roblox.Friends.Api.FriendRequest"
    },
    "mutualFriendsList": {
      "description": "mutualFriendsList",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "hasVerifiedBadge": {
      "description": "The user's verified badge status.",
      "type": "boolean"
    },
    "isUnseen": {
      "description": "The user's verified badge status.",
      "type": "boolean"
    },
    "description": {
      "description": "The user description.",
      "type": "string"
    },
    "created": {
      "format": "date-time",
      "description": "When the user signed up.",
      "type": "string"
    },
    "isBanned": {
      "description": "Whether or not the user is banned",
      "type": "boolean"
    },
    "externalAppDisplayName": {
      "description": "Used when user is logged in from third party app (e.g. QQ)\r\nExternalAppDisplayName is the name used in that app (e.g. QQ nickname)",
      "type": "string"
    },
    "id": {
      "format": "int64",
      "description": "The user Id.",
      "type": "integer"
    },
    "name": {
      "description": "The user name.",
      "type": "string"
    },
    "displayName": {
      "description": "The user DisplayName.",
      "type": "string"
    }
  },
  "additionalProperties": false
}