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.

Roblox.Badges.Api.BadgeResponse — openapi

A response containing badge information.

Properties

NameTypeRequiredDescription
idintegerfalseThe badge Id.
namestringfalseThe name of the badge.
descriptionstringfalseThe badge description.
displayNamestringfalseThe localized name of the badge.
displayDescriptionstringfalseThe localized badge description.
enabledbooleanfalseWhether or not the badge is enabled.
iconImageIdintegerfalseThe badge icon asset Id.
displayIconImageIdintegerfalseThe localized badge icon asset Id.
createdstringfalseWhen the badge was created.
updatedstringfalseWhen the badge was updated.
statistics#/components/schemas/Roblox.Web.Responses.Badges.BadgeAwardStatisticsResponsefalse
awardingUniverse#/components/schemas/Roblox.Badges.Api.UniverseResponsefalse

Complete Schema

{
  "description": "A response containing badge information.",
  "type": "object",
  "properties": {
    "id": {
      "format": "int64",
      "description": "The badge Id.",
      "type": "integer"
    },
    "name": {
      "description": "The name of the badge.",
      "type": "string"
    },
    "description": {
      "description": "The badge description.",
      "type": "string"
    },
    "displayName": {
      "description": "The localized name of the badge.",
      "type": "string"
    },
    "displayDescription": {
      "description": "The localized badge description.",
      "type": "string"
    },
    "enabled": {
      "description": "Whether or not the badge is enabled.",
      "type": "boolean"
    },
    "iconImageId": {
      "format": "int64",
      "description": "The badge icon asset Id.",
      "type": "integer"
    },
    "displayIconImageId": {
      "format": "int64",
      "description": "The localized badge icon asset Id.",
      "type": "integer"
    },
    "created": {
      "format": "date-time",
      "description": "When the badge was created.",
      "type": "string"
    },
    "updated": {
      "format": "date-time",
      "description": "When the badge was updated.",
      "type": "string"
    },
    "statistics": {
      "$ref": "#/components/schemas/Roblox.Web.Responses.Badges.BadgeAwardStatisticsResponse"
    },
    "awardingUniverse": {
      "$ref": "#/components/schemas/Roblox.Badges.Api.UniverseResponse"
    }
  },
  "additionalProperties": false
}