Mojang · JSON Structure

Minecraft Services Friends List Structure

Friends and pending friend requests for the authenticated player.

Type: object Properties: 4
Games And ComicsMinecraftGamingIdentityPlayer ProfilesSessionPublic APIs

FriendsList is a JSON Structure definition published by Mojang, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

friends incomingRequests outgoingRequests empty

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mojang/refs/heads/main/json-structure/minecraft-services-friends-list-structure.json",
  "name": "FriendsList",
  "description": "Friends and pending friend requests for the authenticated player.",
  "type": "object",
  "properties": {
    "friends": {
      "type": "array",
      "description": "Confirmed friends.",
      "items": {
        "$ref": "#/components/schemas/Friend"
      }
    },
    "incomingRequests": {
      "type": "array",
      "description": "Pending inbound friend requests.",
      "items": {
        "$ref": "#/components/schemas/Friend"
      }
    },
    "outgoingRequests": {
      "type": "array",
      "description": "Pending outbound friend requests.",
      "items": {
        "$ref": "#/components/schemas/Friend"
      }
    },
    "empty": {
      "type": "boolean",
      "description": "Convenience flag \u2014 true if no friends or requests.",
      "example": false
    }
  }
}