Away 12:11 AM

3 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/promotion-channels — openapi

Get the user's promotion channels

Endpoint

Method: GET

Path: /v1/promotion-channels

Servers:

Parameters

NameLocationRequiredDescription
alwaysReturnUrlsqueryfalseWhether all promotion channel links should be returned as full URLs.
filterLinkqueryfalseWhether all promotion channel links should be filtered.
onlyShortenTwitterqueryfalseWhether all promotion channels links except for Twitter should be returned as full URLs. If false, all promotion channels will be shortened.
 
[
  {
    "in": "query",
    "name": "alwaysReturnUrls",
    "description": "Whether all promotion channel links should be returned as full URLs.",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "in": "query",
    "name": "filterLink",
    "description": "Whether all promotion channel links should be filtered.",
    "schema": {
      "type": "boolean",
      "default": false
    }
  },
  {
    "in": "query",
    "name": "onlyShortenTwitter",
    "description": "Whether all promotion channels links except for Twitter should be returned as full URLs. If false, all promotion channels will be shortened.",
    "schema": {
      "type": "boolean",
      "default": true
    }
  }
]

Responses

StatusDescription
200OK
4001: User not found.
4010: Authorization has been denied for this request.
 
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.AccountInformation.Api.Models.PromotionChannelsResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.AccountInformation.Api.Models.PromotionChannelsResponse"
        }
      }
    }
  },
  "400": {
    "description": "1: User not found."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  }
}

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": [
    "Accounts",
    "User profiles"
  ],
  "summary": "Get the user's promotion channels",
  "parameters": [
    {
      "in": "query",
      "name": "alwaysReturnUrls",
      "description": "Whether all promotion channel links should be returned as full URLs.",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "in": "query",
      "name": "filterLink",
      "description": "Whether all promotion channel links should be filtered.",
      "schema": {
        "type": "boolean",
        "default": false
      }
    },
    {
      "in": "query",
      "name": "onlyShortenTwitter",
      "description": "Whether all promotion channels links except for Twitter should be returned as full URLs. If false, all promotion channels will be shortened.",
      "schema": {
        "type": "boolean",
        "default": true
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.AccountInformation.Api.Models.PromotionChannelsResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.AccountInformation.Api.Models.PromotionChannelsResponse"
          }
        }
      }
    },
    "400": {
      "description": "1: User not found."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    }
  },
  "servers": [
    {
      "url": "https://accountinformation.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/accounts#accountinformation_get_v1_promotion_channels"
  }
}