1 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.FriendStatusResponse — openapi

The friendship status response model.

Properties

NameTypeRequiredDescription
idintegerfalseThe user Id of the friend.
statusintegerfalseThe friendship status. ['NotFriends' = 0, 'Friends' = 1, 'RequestSent' = 2, 'RequestReceived' = 3]

Complete Schema

{
  "description": "The friendship status response model.",
  "type": "object",
  "properties": {
    "id": {
      "format": "int64",
      "description": "The user Id of the friend.",
      "type": "integer"
    },
    "status": {
      "format": "int32",
      "description": "The friendship status. ['NotFriends' = 0, 'Friends' = 1, 'RequestSent' = 2, 'RequestReceived' = 3]",
      "enum": [
        0,
        1,
        2,
        3
      ],
      "type": "integer"
    }
  },
  "additionalProperties": false
}