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/universes/{universeId}/badges — openapi

Gets badges by their awarding game.

Lists badges created under the universe's root place, with paging and optional sort.

Endpoint

Method: GET

Path: /v1/universes/{universeId}/badges

Servers:

Parameters

NameLocationRequiredDescription
universeIdpathtrueThe universe Id.
sortByqueryfalseThe key to sort badges by.
limitqueryfalseThe number of results per request.
cursorqueryfalseThe paging cursor for the previous or next page.
sortOrderqueryfalseThe order the results are sorted in.
[
  {
    "in": "path",
    "name": "universeId",
    "description": "The universe Id.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "sortBy",
    "description": "The key to sort badges by.",
    "schema": {
      "type": "string",
      "enum": [
        "Rank",
        "DateCreated"
      ]
    }
  },
  {
    "in": "query",
    "name": "limit",
    "description": "The number of results per request.",
    "schema": {
      "type": "integer",
      "format": "int32",
      "enum": [
        10,
        25,
        50,
        100
      ],
      "default": 10
    }
  },
  {
    "in": "query",
    "name": "cursor",
    "description": "The paging cursor for the previous or next page.",
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "sortOrder",
    "description": "The order the results are sorted in.",
    "schema": {
      "type": "string",
      "enum": [
        "Asc",
        "Desc"
      ],
      "default": "Asc"
    }
  }
]

Responses

StatusDescription
200OK
40026: The pagination cursor is invalid or incompatible with the current request.
4043: The game is invalid or does not exist.
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Badges.Api.BadgeResponse_"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Badges.Api.BadgeResponse_"
        }
      }
    }
  },
  "400": {
    "description": "26: The pagination cursor is invalid or incompatible with the current request."
  },
  "404": {
    "description": "3: 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",
    "Universes"
  ],
  "summary": "Gets badges by their awarding game.",
  "description": "Lists badges created under the universe's root place, with paging and optional sort.",
  "parameters": [
    {
      "in": "path",
      "name": "universeId",
      "description": "The universe Id.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "sortBy",
      "description": "The key to sort badges by.",
      "schema": {
        "type": "string",
        "enum": [
          "Rank",
          "DateCreated"
        ]
      }
    },
    {
      "in": "query",
      "name": "limit",
      "description": "The number of results per request.",
      "schema": {
        "type": "integer",
        "format": "int32",
        "enum": [
          10,
          25,
          50,
          100
        ],
        "default": 10
      }
    },
    {
      "in": "query",
      "name": "cursor",
      "description": "The paging cursor for the previous or next page.",
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "sortOrder",
      "description": "The order the results are sorted in.",
      "schema": {
        "type": "string",
        "enum": [
          "Asc",
          "Desc"
        ],
        "default": "Asc"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Badges.Api.BadgeResponse_"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Badges.Api.BadgeResponse_"
          }
        }
      }
    },
    "400": {
      "description": "26: The pagination cursor is invalid or incompatible with the current request."
    },
    "404": {
      "description": "3: 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_universes__universeId__badges"
  }
}