Away 11:33 PM

3 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/game-passes/{gamePassId}/icons — openapi

Get all icons for a game pass

Endpoint

Method: GET

Path: /v1/game-passes/{gamePassId}/icons

Servers:

Parameters

NameLocationRequiredDescription
gamePassIdpathtrueThe game pass id
widthqueryfalseThe width of the icon to request
heightqueryfalseThe height of the icon to request
 
[
  {
    "in": "path",
    "name": "gamePassId",
    "description": "The game pass id",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "width",
    "description": "The width of the icon to request",
    "schema": {
      "type": "integer",
      "format": "int32",
      "default": 150
    }
  },
  {
    "in": "query",
    "name": "height",
    "description": "The height of the icon to request",
    "schema": {
      "type": "integer",
      "format": "int32",
      "default": 150
    }
  }
]

Responses

StatusDescription
200OK
40052: Image dimensions are invalid 61: Invalid game pass id
4010: Authorization has been denied for this request.
5000: An unknown error occurred.
50317: Feature is disabled
 
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.GameInternationalization.Api.GetGamePassIconResponse_"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.GameInternationalization.Api.GetGamePassIconResponse_"
        }
      }
    }
  },
  "400": {
    "description": "52: Image dimensions are invalid\r\n61: Invalid game pass id"
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "500": {
    "description": "0: An unknown error occurred."
  },
  "503": {
    "description": "17: Feature is disabled"
  }
}

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": [
    "Game passes",
    "Localization"
  ],
  "summary": "Get all icons for a game pass",
  "parameters": [
    {
      "in": "path",
      "name": "gamePassId",
      "description": "The game pass id",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "width",
      "description": "The width of the icon to request",
      "schema": {
        "type": "integer",
        "format": "int32",
        "default": 150
      }
    },
    {
      "in": "query",
      "name": "height",
      "description": "The height of the icon to request",
      "schema": {
        "type": "integer",
        "format": "int32",
        "default": 150
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.GameInternationalization.Api.GetGamePassIconResponse_"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.GameInternationalization.Api.GetGamePassIconResponse_"
          }
        }
      }
    },
    "400": {
      "description": "52: Image dimensions are invalid\r\n61: Invalid game pass id"
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "500": {
      "description": "0: An unknown error occurred."
    },
    "503": {
      "description": "17: Feature is disabled"
    }
  },
  "servers": [
    {
      "url": "https://gameinternationalization.roblox.com"
    }
  ],
  "x-roblox-stability": "EXPERIMENTAL",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/game-passes#gameinternationalization_get_v1_game_passes__gamePassId__icons"
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://apis.roblox.com/legacy-game-internationalization/v1/game-passes/{gamePassId}/icons",
      "httpMethod": "GET",
      "documentationUrl": "https://create.roblox.com/docs/cloud/reference/features/game-passes#get_legacy_game_internationalization_v1_game_passes__gamePassId__icons"
    }
  ]
}