GET /v4/outfits/{outfitId}/details — openapi

Gets the definition for an outfit.

Returns an Roblox.Api.Avatar.Models.V4.OutfitDefinition containing an Roblox.Api.Avatar.Models.V4.OutfitModelV4 and background Roblox.Api.Avatar.Models.V4.OutfitConfigurations. Behavior is aligned with the V1/V3 GET v{1|3}/outfits/{userOutfitId}/details endpoints (authentication optional).

Endpoint

Method: GET

Path: /v4/outfits/{outfitId}/details

Servers:

https://avatar.roblox.com

Parameters

Name	Location	Required	Description
outfitId	path	true	The outfit id.
selectionTypes	query	false	Selection types for the outfit data to return.
checkAssetAvailability	query	false	Whether to return assets with availability status.
Roblox-Place-Id	header	false

[
  {
    "in": "path",
    "name": "outfitId",
    "description": "The outfit id.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "selectionTypes",
    "description": "Selection types for the outfit data to return.",
    "explode": true,
    "schema": {
      "type": "array",
      "items": {
        "format": "int32",
        "description": "Defines the data that can be requested while retrieving an OutfitDefinition.",
        "enum": [
          0,
          1
        ],
        "type": "integer"
      }
    }
  },
  {
    "in": "query",
    "name": "checkAssetAvailability",
    "description": "Whether to return assets with availability status.",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "in": "header",
    "name": "Roblox-Place-Id",
    "description": "",
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Responses

Status	Description
200	OK
400	2: The outfit for the specified userOutfit is invalid.
403	3: The requester does not have access to the details for the given user outfit.
404	1: The specified userOutfitId is invalid.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.V4.OutfitDefinition"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.V4.OutfitDefinition"
        }
      }
    }
  },
  "400": {
    "description": "2: The outfit for the specified userOutfit is invalid."
  },
  "403": {
    "description": "3: The requester does not have access to the details for the given user outfit."
  },
  "404": {
    "description": "1: The specified userOutfitId is invalid."
  }
}

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.OutfitDefinition

Complete Operation Definition

{
  "tags": [
    "Avatars"
  ],
  "summary": "Gets the definition for an outfit.",
  "description": "Returns an Roblox.Api.Avatar.Models.V4.OutfitDefinition containing an Roblox.Api.Avatar.Models.V4.OutfitModelV4 and background Roblox.Api.Avatar.Models.V4.OutfitConfigurations.\r\nBehavior is aligned with the V1/V3 `GET v{1|3}/outfits/{userOutfitId}/details` endpoints (authentication optional).",
  "parameters": [
    {
      "in": "path",
      "name": "outfitId",
      "description": "The outfit id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "selectionTypes",
      "description": "Selection types for the outfit data to return.",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "format": "int32",
          "description": "Defines the data that can be requested while retrieving an OutfitDefinition.",
          "enum": [
            0,
            1
          ],
          "type": "integer"
        }
      }
    },
    {
      "in": "query",
      "name": "checkAssetAvailability",
      "description": "Whether to return assets with availability status.",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "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.OutfitDefinition"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Avatar.Models.V4.OutfitDefinition"
          }
        }
      }
    },
    "400": {
      "description": "2: The outfit for the specified userOutfit is invalid."
    },
    "403": {
      "description": "3: The requester does not have access to the details for the given user outfit."
    },
    "404": {
      "description": "1: The specified userOutfitId is invalid."
    }
  },
  "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_outfits__outfitId__details"
  }
}