Away 9:31 PM

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 /v2/sponsored-games — openapi

Gets a page of Roblox.AdConfiguration.Api.SponsoredGameV2Model with specified input parameters.

Endpoint

Method: GET

Path: /v2/sponsored-games

Servers:

Parameters

NameLocationRequiredDescription
universeIdquerytrueThe universe id of the ad campaign.
includeReportingStatsqueryfalseIndicates whether to include reporting stats in the response.
isArchivedqueryfalseIndicates whether to retrieve archived ads.
pageCursorqueryfalseThe cursor of the page to retrieve.
 
[
  {
    "in": "query",
    "name": "universeId",
    "description": "The universe id of the ad campaign.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "in": "query",
    "name": "includeReportingStats",
    "description": "Indicates whether to include reporting stats in the response.",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "in": "query",
    "name": "isArchived",
    "description": "Indicates whether to retrieve archived ads.",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "in": "query",
    "name": "pageCursor",
    "description": "The cursor of the page to retrieve.",
    "schema": {
      "type": "string"
    }
  }
]

Responses

StatusDescription
200OK
4009: Cannot load the universe for the specified universe id. 9: Cannot load the universe for the specified universe id.
4010: Authorization has been denied for this request.
5031: This feature is disabled.
 
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.AdConfiguration.Api.GetSponsoredGamesResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.AdConfiguration.Api.GetSponsoredGamesResponse"
        }
      }
    }
  },
  "400": {
    "description": "9: Cannot load the universe for the specified universe id.\r\n9: Cannot load the universe for the specified universe id."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "503": {
    "description": "1: This 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": [
    "Advertising"
  ],
  "summary": "Gets a page of Roblox.AdConfiguration.Api.SponsoredGameV2Model with specified input parameters.",
  "parameters": [
    {
      "in": "query",
      "name": "universeId",
      "description": "The universe id of the ad campaign.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "in": "query",
      "name": "includeReportingStats",
      "description": "Indicates whether to include reporting stats in the response.",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "in": "query",
      "name": "isArchived",
      "description": "Indicates whether to retrieve archived ads.",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "in": "query",
      "name": "pageCursor",
      "description": "The cursor of the page to retrieve.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.AdConfiguration.Api.GetSponsoredGamesResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.AdConfiguration.Api.GetSponsoredGamesResponse"
          }
        }
      }
    },
    "400": {
      "description": "9: Cannot load the universe for the specified universe id.\r\n9: Cannot load the universe for the specified universe id."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "503": {
      "description": "1: This feature is disabled."
    }
  },
  "servers": [
    {
      "url": "https://adconfiguration.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/advertising#adconfiguration_get_v2_sponsored_games"
  }
}