2 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/badges/{badgeId} — openapi

Gets badge information by the badge Id.

Returns display fields, award statistics, and owning universe for a single badge.

Endpoint

Method: GET

Path: /v1/badges/{badgeId}

Servers:

Parameters

NameLocationRequiredDescription
badgeIdpathtrueThe badge Id.
[
  {
    "in": "path",
    "name": "badgeId",
    "description": "The badge Id.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Responses

StatusDescription
200OK
4041: Badge is invalid or does not exist. 3: The game is invalid or does not exist.
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Badges.Api.BadgeResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Badges.Api.BadgeResponse"
        }
      }
    }
  },
  "404": {
    "description": "1: Badge is invalid or does not exist.\r\n3: The game is invalid or 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": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Badges"
  ],
  "summary": "Gets badge information by the badge Id.",
  "description": "Returns display fields, award statistics, and owning universe for a single badge.",
  "parameters": [
    {
      "in": "path",
      "name": "badgeId",
      "description": "The badge Id.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Badges.Api.BadgeResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Badges.Api.BadgeResponse"
          }
        }
      }
    },
    "404": {
      "description": "1: Badge is invalid or does not exist.\r\n3: The game is invalid or does not exist."
    }
  },
  "servers": [
    {
      "url": "https://badges.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/badges#badges_get_v1_badges__badgeId_"
  }
}