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.

SubcategoryQueryParams — toolbox-service/v1

The parameters we'll use when querying assets NOTE: All fields must be nullable to avoid improper filtering

Properties

NameTypeRequiredDescription
keywordstringfalseThe search keyword to use
assetSubTypesarrayfalseA list of subtypes to use (e.g. MaterialPack, Ad, etc.)
creatorTargetIdintegerfalseThe creator target ID filter.
creatorTypefalseThe creator type ID.
excludeAssetSubTypesarrayfalseA list of subtype to remove https://jira.rbx.com/browse/STM-2597.
audioTypesarrayfalseA list of audio types to include (e.g. Music, SoundEffect, Unknown).
uiSortIntentfalseThe UI sort intent.
sortDirectionfalseThe sort direction.
musicChartTypefalseThe music chart type.
categoryPathstringfalseThe taxonomy category path slug to use for category filtering

Complete Schema

{
  "type": "object",
  "properties": {
    "keyword": {
      "type": "string",
      "description": "The search keyword to use",
      "nullable": true
    },
    "assetSubTypes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssetSubType"
      },
      "description": "A list of subtypes to use (e.g. MaterialPack, Ad, etc.)",
      "nullable": true
    },
    "creatorTargetId": {
      "type": "integer",
      "description": "The creator target ID filter.",
      "format": "int64",
      "nullable": true
    },
    "creatorType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreatorType"
        }
      ],
      "description": "The creator type ID.",
      "nullable": true
    },
    "excludeAssetSubTypes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssetSubType"
      },
      "description": "A list of subtype to remove https://jira.rbx.com/browse/STM-2597.",
      "nullable": true
    },
    "audioTypes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AudioType"
      },
      "description": "A list of audio types to include (e.g. Music, SoundEffect, Unknown).",
      "nullable": true
    },
    "uiSortIntent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UiSortIntent"
        }
      ],
      "description": "The UI sort intent.",
      "nullable": true
    },
    "sortDirection": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SortDirection"
        }
      ],
      "description": "The sort direction.",
      "nullable": true
    },
    "musicChartType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MusicChartType"
        }
      ],
      "description": "The music chart type.",
      "nullable": true
    },
    "categoryPath": {
      "type": "string",
      "description": "The taxonomy category path slug to use for category filtering",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "The parameters we'll use when querying assets\r\nNOTE: All fields *must* be nullable to avoid improper filtering",
  "nullable": true
}