2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Roblox.ClientSettings.Api.Models.Response.UserChannelResponse — openapi

Response data object for getting a user's channel information.

Properties

NameTypeRequiredDescription
channelNamestringfalseName of the channel.
channelAssignmentTypeintegerfalseHow the user was bound to the channel. If the user is not assigned to any channel, this is omitted. ['None' = 0, 'PerMille' = 1, 'BoundToPrivateChannel' = 2, 'BoundToPublicChannel' = 3, 'OptedInToBetaProgramWithPrivateChannel' = 4, 'OptedInToBetaProgramWithPublicChannel' = 5]
tokenstringfalseJWT token. If the channel is not private, this is omitted.
program#/components/schemas/Roblox.ClientSettings.Api.Models.Response.BetaProgramInfofalse
isFlagOnlybooleanfalseWhether the channel is flag-only. A flag-only channel uses production binaries. If the channel is not flag-only, this is omitted.

Complete Schema

{
  "description": "Response data object for getting a user's channel information.",
  "type": "object",
  "properties": {
    "channelName": {
      "description": "Name of the channel.",
      "type": "string"
    },
    "channelAssignmentType": {
      "format": "int32",
      "description": "How the user was bound to the channel. If the user is not assigned to any channel, this is omitted. ['None' = 0, 'PerMille' = 1, 'BoundToPrivateChannel' = 2, 'BoundToPublicChannel' = 3, 'OptedInToBetaProgramWithPrivateChannel' = 4, 'OptedInToBetaProgramWithPublicChannel' = 5]",
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "type": "integer"
    },
    "token": {
      "description": "JWT token. If the channel is not private, this is omitted.",
      "type": "string"
    },
    "program": {
      "$ref": "#/components/schemas/Roblox.ClientSettings.Api.Models.Response.BetaProgramInfo"
    },
    "isFlagOnly": {
      "description": "Whether the channel is flag-only. A flag-only channel uses production binaries.\nIf the channel is not flag-only, this is omitted.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}