GET /v1/universes/{universeId}/free-badges-quota — openapi

Gets the number of free badges left for the current UTC day by their awarding game.

Reflects daily free-creation allowance for the universe when the feature is enabled.

Endpoint

Method: GET

Path: /v1/universes/{universeId}/free-badges-quota

Servers:

https://badges.roblox.com

Parameters

Name	Location	Required	Description
universeId	path	true	The universe Id.

[
  {
    "in": "path",
    "name": "universeId",
    "description": "The universe Id.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Responses

Status	Description
200	OK
404	3: The game is invalid or does not exist.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "format": "int32",
          "type": "integer"
        }
      },
      "text/json": {
        "schema": {
          "format": "int32",
          "type": "integer"
        }
      }
    }
  },
  "404": {
    "description": "3: The game is invalid or does not exist."
  }
}

Authentication

{
  "security": [
    {}
  ],
  "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 the number of free badges left for the current UTC day by their awarding game.",
  "description": "Reflects daily free-creation allowance for the universe when the feature is enabled.",
  "parameters": [
    {
      "in": "path",
      "name": "universeId",
      "description": "The universe Id.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "format": "int32",
            "type": "integer"
          }
        },
        "text/json": {
          "schema": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    },
    "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": [
    {}
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/badges#badges_get_v1_universes__universeId__free_badges_quota"
  }
}