Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
SearchCreatorStoreAssetsRequest — openapi
Request model for searching Creator Store assets.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| searchCategoryType | false | The asset type to search within. Optional when Toolbox.Service.SearchCreatorStoreAssetsRequest.CategoryPath resolves to an asset type; otherwise required. | |
| query | string | false | The search terms used to filter the results. Only one of 'query' and 'image' can be present in a query. |
| image | string | false | The image file to search by. The image must be base64 encoded to be used in the search. Only one of 'query' and 'image' can be present in a query. |
| userId | integer | false | The User ID of the creator. Only one of 'userId' and 'groupId' can be present in a query. |
| groupId | integer | false | The Group ID of the creator. Only one of 'userId' and 'groupId' can be present in a query. |
| pageToken | string | false | The identifier for the desired search results page. Only one of 'pageNumber' and 'pageToken' can be present in a query. |
| pageNumber | integer | false | The page number to retrieve, starting from 0. Only one of 'pageNumber' and 'pageToken' can be present in a query. |
| maxPageSize | integer | false | The number of assets to be returned. Cannot be larger than 100. |
| sortDirection | false | The sort direction of the search results. | |
| sortCategory | false | The category to sort the search results by. | |
| includeOnlyVerifiedCreators | boolean | false | Whether the results should only include assets created by verified creators. |
| minPriceCents | integer | false | The minimum price of the asset in cents. If included, must be greater than or equal to 0. |
| maxPriceCents | integer | false | The maximum price of the asset in cents. If included, must be greater than or equal to 0. |
| facets | array | false | Additional keywords to query by. |
| tags | array | false | The tags to filter by. |
| categoryPath | string | false | The category path to filter by. |
| swimlane | string | false | Optional swimlane identifier (e.g. "trending", "essential", "priced"). |
| searchView | false | Indicates which fields will be populated in the response. | |
| audioSearchFilters | false | Audio-specific search filters. | |
| modelSearchFilters | false | Model-specific search filters. |
Related Schemas
Complete Schema
{
"type": "object",
"properties": {
"searchCategoryType": {
"allOf": [
{
"$ref": "#/components/schemas/SearchCategoryType"
}
],
"description": "The asset type to search within. Optional when Toolbox.Service.SearchCreatorStoreAssetsRequest.CategoryPath\nresolves to an asset type; otherwise required.",
"nullable": true
},
"query": {
"type": "string",
"description": "The search terms used to filter the results. Only one of 'query' and 'image' can be present in a query.",
"nullable": true
},
"image": {
"type": "string",
"description": "The image file to search by. The image must be base64 encoded to be used in the search. Only one of 'query' and 'image' can be present in a query.",
"format": "byte",
"nullable": true
},
"userId": {
"maximum": 9223372036854776000,
"minimum": 1,
"type": "integer",
"description": "The User ID of the creator. Only one of 'userId' and 'groupId' can be present in a query.",
"format": "int64",
"nullable": true
},
"groupId": {
"maximum": 9223372036854776000,
"minimum": 1,
"type": "integer",
"description": "The Group ID of the creator. Only one of 'userId' and 'groupId' can be present in a query.",
"format": "int64",
"nullable": true
},
"pageToken": {
"type": "string",
"description": "The identifier for the desired search results page. Only one of 'pageNumber' and 'pageToken' can be present in a query.",
"nullable": true
},
"pageNumber": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "The page number to retrieve, starting from 0. Only one of 'pageNumber' and 'pageToken' can be present in a query.",
"format": "int32",
"nullable": true
},
"maxPageSize": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"description": "The number of assets to be returned. Cannot be larger than 100.",
"format": "int32"
},
"sortDirection": {
"allOf": [
{
"$ref": "#/components/schemas/SortDirection"
}
],
"description": "The sort direction of the search results.",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"x-enum-varnames": [
"None",
"Ascending",
"Descending"
]
},
"sortCategory": {
"allOf": [
{
"$ref": "#/components/schemas/SortCategory"
}
],
"description": "The category to sort the search results by.",
"x-enumNames": [
"Relevance",
"Trending",
"Top",
"AudioDuration",
"CreateTime",
"UpdatedTime",
"Ratings"
],
"x-enum-varnames": [
"Relevance",
"Trending",
"Top",
"AudioDuration",
"CreateTime",
"UpdatedTime",
"Ratings"
]
},
"includeOnlyVerifiedCreators": {
"type": "boolean",
"description": "Whether the results should only include assets created by verified creators."
},
"minPriceCents": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "The minimum price of the asset in cents. If included, must be greater than or equal to 0.",
"format": "int64",
"nullable": true
},
"maxPriceCents": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "The maximum price of the asset in cents. If included, must be greater than or equal to 0.",
"format": "int64",
"nullable": true
},
"facets": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additional keywords to query by.",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags to filter by.",
"nullable": true
},
"categoryPath": {
"type": "string",
"description": "The category path to filter by.",
"nullable": true
},
"swimlane": {
"type": "string",
"description": "Optional swimlane identifier (e.g. \"trending\", \"essential\", \"priced\").",
"nullable": true
},
"searchView": {
"allOf": [
{
"$ref": "#/components/schemas/SearchView"
}
],
"description": "Indicates which fields will be populated in the response.",
"x-enumNames": [
"IDs",
"Core",
"Full"
],
"x-enum-varnames": [
"IDs",
"Core",
"Full"
]
},
"audioSearchFilters": {
"allOf": [
{
"$ref": "#/components/schemas/AudioSearchFilters"
}
],
"description": "Audio-specific search filters.",
"nullable": true
},
"modelSearchFilters": {
"allOf": [
{
"$ref": "#/components/schemas/ModelSearchFilters"
}
],
"description": "Model-specific search filters.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for searching Creator Store assets.",
"nullable": true
}