Away 12:13 AM

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.

SubcategoryModel — toolbox-service/v1

Represents a basic subcategory.

Properties

NameTypeRequiredDescription
namestringfalseThe name of the subcategory.
displayNamestringfalseThe display name of the subcategory.
hiddenbooleanfalseWhether this category should be hidden in client side lists
searchKeywordsstringfalseThe search keywords to use for this subcategory
queryParamsfalseThe parameters we'll use when getting assets
patharrayfalseThe full path of the subcategory
indexintegerfalseThe index/order of the subcategory in the list
childrenobjectfalseThe children nested under this subcategory.
childCountintegerfalseThe number of children
thumbnailfalseOptional thumbnail information for the subcategory
categoryPathstringfalseThe taxonomy slug for this subcategory. e.g. "3d__characters"

Complete Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the subcategory.",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the subcategory.",
      "nullable": true
    },
    "hidden": {
      "type": "boolean",
      "description": "Whether this category should be hidden in client side lists"
    },
    "searchKeywords": {
      "type": "string",
      "description": "The search keywords to use for this subcategory",
      "nullable": true,
      "deprecated": true
    },
    "queryParams": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SubcategoryQueryParams"
        }
      ],
      "description": "The parameters we'll use when getting assets",
      "nullable": true
    },
    "path": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The full path of the subcategory",
      "nullable": true
    },
    "index": {
      "type": "integer",
      "description": "The index/order of the subcategory in the list",
      "format": "int32"
    },
    "children": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/SubcategoryModel"
      },
      "description": "The children nested under this subcategory.",
      "nullable": true
    },
    "childCount": {
      "type": "integer",
      "description": "The number of children",
      "format": "int32",
      "readOnly": true
    },
    "thumbnail": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SubcategoryThumbnail"
        }
      ],
      "description": "Optional thumbnail information for the subcategory",
      "nullable": true
    },
    "categoryPath": {
      "type": "string",
      "description": "The taxonomy slug for this subcategory. e.g. \"3d__characters\"",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Represents a basic subcategory.",
  "nullable": true
}