Away 10:19 PM

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/users/{userId}/promotion-channels — openapi

Get promotion channels for a given user ID

Endpoint

Method: GET

Path: /v1/users/{userId}/promotion-channels

Servers:

Parameters

NameLocationRequiredDescription
userIdpathtrueThe ID of the user to fetch the promotion channels for.
alwaysReturnUrlsqueryfalseWhether all promotion channel links should be returned as full URLs.
filterLinkqueryfalseWhether all promotion channel links should be filtered.
 
[
  {
    "in": "path",
    "name": "userId",
    "description": "The ID of the user to fetch the promotion channels for.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "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
    }
  }
]

Responses

StatusDescription
200OK
4001: User not found.
 
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.AccountInformation.Api.Models.PromotionChannelsByUserIdResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.AccountInformation.Api.Models.PromotionChannelsByUserIdResponse"
        }
      }
    }
  },
  "400": {
    "description": "1: User not found."
  }
}

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",
    "Users"
  ],
  "summary": "Get promotion channels for a given user ID",
  "parameters": [
    {
      "in": "path",
      "name": "userId",
      "description": "The ID of the user to fetch the promotion channels for.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "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
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.AccountInformation.Api.Models.PromotionChannelsByUserIdResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.AccountInformation.Api.Models.PromotionChannelsByUserIdResponse"
          }
        }
      }
    },
    "400": {
      "description": "1: User not found."
    }
  },
  "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_users__userId__promotion_channels"
  }
}