GET /v1/games/icons — openapi

Fetches game icon URLs for a list of universes' root places. Ids that do not correspond to a valid universe will be filtered out. The ordering of the results is not guaranteed to be the same as the inputs. In order to correlated inputs with outputs please use the 'targetId' of the objects in the result array.

Endpoint

Method: GET

Path: /v1/games/icons

Servers:

https://thumbnails.roblox.com

Parameters

Name	Location	Required	Description
universeIds	query	true	The universe ids.
returnPolicy	query	false	Optional policy to use in selecting game icon to return (default = PlaceHolder).
size	query	false	The thumbnail size, formatted widthxheight
format	query	false	The thumbnail format
isCircular	query	false	The circle thumbnail output parameter, true or false

[
  {
    "in": "query",
    "name": "universeIds",
    "description": "The universe ids.",
    "required": true,
    "style": "form",
    "explode": false,
    "schema": {
      "type": "array",
      "items": {
        "format": "int64",
        "type": "integer"
      }
    }
  },
  {
    "in": "query",
    "name": "returnPolicy",
    "description": "Optional policy to use in selecting game icon to return (default = PlaceHolder).",
    "schema": {
      "type": "string",
      "enum": [
        "PlaceHolder",
        "ForcePlaceHolder",
        "AutoGenerated",
        "ForceAutoGenerated"
      ],
      "default": "PlaceHolder"
    }
  },
  {
    "in": "query",
    "name": "size",
    "description": "The thumbnail size, formatted widthxheight",
    "schema": {
      "type": "string",
      "enum": [
        "50x50",
        "128x128",
        "150x150",
        "256x256",
        "420x420",
        "512x512"
      ],
      "default": "50x50"
    }
  },
  {
    "in": "query",
    "name": "format",
    "description": "The thumbnail format",
    "schema": {
      "type": "string",
      "enum": [
        "Png",
        "Jpeg",
        "Webp",
        "Ico",
        "Icns"
      ],
      "default": "Png"
    }
  },
  {
    "in": "query",
    "name": "isCircular",
    "description": "The circle thumbnail output parameter, true or false",
    "schema": {
      "type": "boolean",
      "enum": [
        "true",
        "false"
      ],
      "default": "false"
    }
  }
]

Responses

Status	Description
200	OK
400	1: There are too many requested Ids. 2: The requested image format is invalid. Please see documentation for valid thumbnail format parameter name and values. 3: The requested size is invalid. Please see documentation for valid thumbnail size parameter name and format. 4: The requested Ids are invalid, of an invalid type or missing. 8: The requested return policy is invalid (must be PlaceHolder, AutoGenerated or ForceAutoGenerated). 10: Circular thumbnail requests are not allowed
403	9: User not authorized to use AutoGenerated or ForceAutoGenerated return policies.

{
  "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\n8: The requested return policy is invalid (must be PlaceHolder, AutoGenerated or ForceAutoGenerated).\r\n10: Circular thumbnail requests are not allowed"
  },
  "403": {
    "description": "9: User not authorized to use AutoGenerated or ForceAutoGenerated return policies."
  }
}

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",
    "Universes"
  ],
  "summary": "Fetches game icon URLs for a list of universes' root places. Ids that do not correspond to a valid universe will be filtered out.\nThe ordering of the results is not guaranteed to be the same as the inputs. In order to correlated inputs with outputs please\nuse the 'targetId' of the objects in the result array.",
  "parameters": [
    {
      "in": "query",
      "name": "universeIds",
      "description": "The universe ids.",
      "required": true,
      "style": "form",
      "explode": false,
      "schema": {
        "type": "array",
        "items": {
          "format": "int64",
          "type": "integer"
        }
      }
    },
    {
      "in": "query",
      "name": "returnPolicy",
      "description": "Optional policy to use in selecting game icon to return (default = PlaceHolder).",
      "schema": {
        "type": "string",
        "enum": [
          "PlaceHolder",
          "ForcePlaceHolder",
          "AutoGenerated",
          "ForceAutoGenerated"
        ],
        "default": "PlaceHolder"
      }
    },
    {
      "in": "query",
      "name": "size",
      "description": "The thumbnail size, formatted widthxheight",
      "schema": {
        "type": "string",
        "enum": [
          "50x50",
          "128x128",
          "150x150",
          "256x256",
          "420x420",
          "512x512"
        ],
        "default": "50x50"
      }
    },
    {
      "in": "query",
      "name": "format",
      "description": "The thumbnail format",
      "schema": {
        "type": "string",
        "enum": [
          "Png",
          "Jpeg",
          "Webp",
          "Ico",
          "Icns"
        ],
        "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\n8: The requested return policy is invalid (must be PlaceHolder, AutoGenerated or ForceAutoGenerated).\r\n10: Circular thumbnail requests are not allowed"
    },
    "403": {
      "description": "9: User not authorized to use AutoGenerated or ForceAutoGenerated return policies."
    }
  },
  "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_games_icons"
  }
}