GET /v4/avatar/users/{userId} — openapi

Gets the currently wearing avatar definition for the specified user.

Returns an Roblox.Api.Avatar.Models.V4.AvatarDefinition containing an Roblox.Api.Avatar.Models.V4.AvatarModelV4 and Roblox.Api.Avatar.Models.V4.AvatarConfigurations. Behavior is aligned with the V2 GET v2/avatar/users/{userId}/avatar endpoint.

Endpoint

Method: GET

Path: /v4/avatar/users/{userId}

Servers:

https://avatar.roblox.com

Parameters

Name	Location	Required	Description
userId	path	true	The target user id.
selectionTypes	query	true	Selection types for the avatar data to return.
Roblox-Place-Id	header	false

[
  {
    "in": "path",
    "name": "userId",
    "description": "The target user id.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "selectionTypes",
    "description": "Selection types for the avatar data to return.",
    "required": true,
    "explode": true,
    "schema": {
      "type": "array",
      "items": {
        "format": "int32",
        "description": "Defines the data that can be requested or modified while retrieving or\r\nupdating the AvatarDefinition.",
        "enum": [
          0,
          1,
          2,
          3,
          4,
          5,
          6
        ],
        "type": "integer"
      }
    }
  },
  {
    "in": "header",
    "name": "Roblox-Place-Id",
    "description": "",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Responses

Status	Description
200	OK
400	1: The specified user does not exist. 2: An account for the given userId does not exist!

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.V4.AvatarDefinition"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.V4.AvatarDefinition"
        }
      }
    }
  },
  "400": {
    "description": "1: The specified user does not exist.\r\n2: An account for the given userId does not exist!"
  }
}

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

Roblox.Api.Avatar.Models.V4.AvatarDefinition

Complete Operation Definition

{
  "tags": [
    "Avatars",
    "User profiles"
  ],
  "summary": "Gets the currently wearing avatar definition for the specified user.",
  "description": "Returns an Roblox.Api.Avatar.Models.V4.AvatarDefinition containing an Roblox.Api.Avatar.Models.V4.AvatarModelV4 and Roblox.Api.Avatar.Models.V4.AvatarConfigurations.\r\nBehavior is aligned with the V2 `GET v2/avatar/users/{userId}/avatar` endpoint.",
  "parameters": [
    {
      "in": "path",
      "name": "userId",
      "description": "The target user id.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "selectionTypes",
      "description": "Selection types for the avatar data to return.",
      "required": true,
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "format": "int32",
          "description": "Defines the data that can be requested or modified while retrieving or\r\nupdating the AvatarDefinition.",
          "enum": [
            0,
            1,
            2,
            3,
            4,
            5,
            6
          ],
          "type": "integer"
        }
      }
    },
    {
      "in": "header",
      "name": "Roblox-Place-Id",
      "description": "",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.V4.AvatarDefinition"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.V4.AvatarDefinition"
          }
        }
      }
    },
    "400": {
      "description": "1: The specified user does not exist.\r\n2: An account for the given userId does not exist!"
    }
  },
  "servers": [
    {
      "url": "https://avatar.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/avatars#avatar_get_v4_avatar_users__userId_"
  }
}