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-campaigns — openapi
Gets a page of Roblox.AdConfiguration.Api.SponsoredCampaignModel with specified input parameters.
Endpoint
Method: GET
Path: /v2/sponsored-campaigns
Servers:
https://adconfiguration.roblox.com
Parameters
| Name | Location | Required | Description |
|---|---|---|---|
| campaignTargetType | query | true | The campaign target type enum value |
| campaignTargetId | query | true | The id of the campaign target |
| includeReportingStats | query | false | Indicates whether to include reporting stats in the response |
| isArchived | query | false | Indicates whether to retrieve archived ads |
| pageCursor | query | false | The cursor of the page to retrieve. If empty, fetches the first page |
[
{
"in": "query",
"name": "campaignTargetType",
"description": "The campaign target type enum value",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3
]
}
},
{
"in": "query",
"name": "campaignTargetId",
"description": "The id of the campaign target",
"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. If empty, fetches the first page",
"schema": {
"type": "string"
}
}
]Responses
| Status | Description |
|---|---|
| 200 | OK |
| 400 | 22: Invalid campaign target ID. 23: Invalid campaign target type. |
| 401 | 0: Authorization has been denied for this request. |
| 503 | 1: This feature is disabled. |
{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.AdConfiguration.Api.GetSponsoredCampaignsResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.AdConfiguration.Api.GetSponsoredCampaignsResponse"
}
}
}
},
"400": {
"description": "22: Invalid campaign target ID.\r\n23: Invalid campaign target type."
},
"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": {}
}
}
}
}
}Related Schemas
Complete Operation Definition
{
"tags": [
"Advertising"
],
"summary": "Gets a page of Roblox.AdConfiguration.Api.SponsoredCampaignModel with specified input parameters.",
"parameters": [
{
"in": "query",
"name": "campaignTargetType",
"description": "The campaign target type enum value",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3
]
}
},
{
"in": "query",
"name": "campaignTargetId",
"description": "The id of the campaign target",
"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. If empty, fetches the first page",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.AdConfiguration.Api.GetSponsoredCampaignsResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Roblox.AdConfiguration.Api.GetSponsoredCampaignsResponse"
}
}
}
},
"400": {
"description": "22: Invalid campaign target ID.\r\n23: Invalid campaign target type."
},
"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_campaigns"
}
}