4 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GET /v1/users/outfits — openapi

Get outfits for the given CSV of userOutfitIds

Endpoint

Method: GET

Path: /v1/users/outfits

Servers:

• https://thumbnails.roblox.com

Parameters

[
  {
    "in": "query",
    "name": "userOutfitIds",
    "description": "CSV for the userOutfitIds to get user outfits",
    "required": true,
    "style": "form",
    "explode": false,
    "schema": {
      "type": "array",
      "items": {
        "format": "int64",
        "type": "integer"
      }
    }
  },
  {
    "in": "query",
    "name": "includeBackground",
    "description": "Whether to include a background in the thumbnail (defaults to false)",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "in": "query",
    "name": "size",
    "description": "The thumbnail size, formatted widthxheight",
    "schema": {
      "type": "string",
      "enum": [
        "150x150",
        "420x420"
      ],
      "default": "150x150"
    }
  },
  {
    "in": "query",
    "name": "format",
    "description": "The thumbnail format",
    "schema": {
      "type": "string",
      "enum": [
        "Png",
        "Webp"
      ],
      "default": "Png"
    }
  },
  {
    "in": "query",
    "name": "isCircular",
    "description": "The circle thumbnail output parameter, true or false",
    "schema": {
      "type": "boolean",
      "enum": [
        "true",
        "false"
      ],
      "default": "false"
    }
  }
]

Responses

{
  "200": {
    "description": "OK"
  },
  "400": {
    "description": "1: There are too many requested Ids.\r\n2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values.\r\n3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format.\r\n4: The requested Ids are invalid, of an invalid type or missing.\r\n10: Circular thumbnail requests are not allowed"
  }
}

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

Complete Operation Definition

{
  "tags": [
    "Thumbnails"
  ],
  "summary": "Get outfits for the given CSV of userOutfitIds",
  "parameters": [
    {
      "in": "query",
      "name": "userOutfitIds",
      "description": "CSV for the userOutfitIds to get user outfits",
      "required": true,
      "style": "form",
      "explode": false,
      "schema": {
        "type": "array",
        "items": {
          "format": "int64",
          "type": "integer"
        }
      }
    },
    {
      "in": "query",
      "name": "includeBackground",
      "description": "Whether to include a background in the thumbnail (defaults to false)",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "in": "query",
      "name": "size",
      "description": "The thumbnail size, formatted widthxheight",
      "schema": {
        "type": "string",
        "enum": [
          "150x150",
          "420x420"
        ],
        "default": "150x150"
      }
    },
    {
      "in": "query",
      "name": "format",
      "description": "The thumbnail format",
      "schema": {
        "type": "string",
        "enum": [
          "Png",
          "Webp"
        ],
        "default": "Png"
      }
    },
    {
      "in": "query",
      "name": "isCircular",
      "description": "The circle thumbnail output parameter, true or false",
      "schema": {
        "type": "boolean",
        "enum": [
          "true",
          "false"
        ],
        "default": "false"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK"
    },
    "400": {
      "description": "1: There are too many requested Ids.\r\n2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values.\r\n3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format.\r\n4: The requested Ids are invalid, of an invalid type or missing.\r\n10: Circular thumbnail requests are not allowed"
    }
  },
  "servers": [
    {
      "url": "https://thumbnails.roblox.com"
    }
  ],
  "x-roblox-stability": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {},
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/thumbnails#thumbnails_get_v1_users_outfits"
  }
}