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.FriendRequest — openapi

A response model representing a friend request.

Properties

NameTypeRequiredDescription
sentAtstringfalseWhen the friend request was sent.
senderIdintegerfalseThe sender user Id.
sourceUniverseIdintegerfalseThe source universe Id which the request was sent in.
originSourceTypeintegerfalseThe origin source type associated with the friend request. ['Unknown' = 0, 'PlayerSearch' = 1, 'QrCode' = 2, 'InGame' = 3, 'UserProfile' = 4, 'QqContactImporter' = 5, 'WeChatContactImporter' = 6, 'ProfileShare' = 7, 'PhoneContactImporter' = 8, 'FriendRecommendations' = 9, 'UserCommunities' = 10, 'TrustedFriend' = 11, 'SchoolMemberList' = 12]
contactNamestringfalseThe contact name associated with the friend request.
senderNicknamestringfalseThe nickname associated with the friend request.

Complete Schema

{
  "description": "A response model representing a friend request.",
  "type": "object",
  "properties": {
    "sentAt": {
      "format": "date-time",
      "description": "When the friend request was sent.",
      "type": "string"
    },
    "senderId": {
      "format": "int64",
      "description": "The sender user Id.",
      "type": "integer"
    },
    "sourceUniverseId": {
      "format": "int64",
      "description": "The source universe Id which the request was sent in.",
      "type": "integer"
    },
    "originSourceType": {
      "format": "int32",
      "description": "The origin source type associated with the friend request. ['Unknown' = 0, 'PlayerSearch' = 1, 'QrCode' = 2, 'InGame' = 3, 'UserProfile' = 4, 'QqContactImporter' = 5, 'WeChatContactImporter' = 6, 'ProfileShare' = 7, 'PhoneContactImporter' = 8, 'FriendRecommendations' = 9, 'UserCommunities' = 10, 'TrustedFriend' = 11, 'SchoolMemberList' = 12]",
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12
      ],
      "type": "integer"
    },
    "contactName": {
      "description": "The contact name associated with the friend request.",
      "type": "string"
    },
    "senderNickname": {
      "description": "The nickname associated with the friend request.",
      "type": "string"
    }
  },
  "additionalProperties": false
}