v1

OpenAPI 3.0.42026-08-068161,1253.1 MB
Assets
Creator Store

Search Creator Store Assets

Search Creator Store for assets.

get/toolbox-service/v2/assets:search

Query parameters

searchCategoryType'Audio' | 'Model' | 'Decal' | 'Plugin' | 'MeshPart' | 'Video' | 'FontFamily'

This represents a "subset" of Toolbox.Service.CategoryType options and represent the full set of "categories" (or asset types) that can be searched upon from the toolbox search API.

The asset type to search within. Optional when categoryPath is present in the request; otherwise required.

querystring

The search terms used to filter the results.

modelSubTypesModelSubType[] nullable

When searching for models, the subtypes associated with the search results.

excludedModelSubTypesModelSubType[] nullable

When searching for models, the subtypes not associated with the search results.

creatorstring

Deprecated: Please refer to the 'userId' and 'groupId' properties instead. The creator type and ID. E.g. "user/123" or "group/456"

userIdinteger nullable

The User ID of the creator. Only one of 'userId' and 'groupId' can be present in a query.

groupIdinteger nullable

The Group ID of the creator. Only one of 'userId' and 'groupId' can be present in a query.

pageTokenstring

The identifier for the desired search results page. Only one of 'pageNumber' and 'pageToken' can be present in a query.

pageNumberinteger nullable

The page number to retrieve, starting from 0. Only one of 'pageNumber' and 'pageToken' can be present in a query.

maxPageSizeinteger

The number of assets to be returned. Cannot be larger than 100.

sortDirection'None' | 'Ascending' | 'Descending'

Represents the direction in which to sort the results

The sort direction of the search results.

sortCategory'Relevance' | 'Trending' | 'Top' | 'AudioDuration' | 'CreateTime' | 'UpdatedTime' | 'Ratings'

The category to sort the search results by.

The category to sort the search results by.

audioMinDurationSecondsinteger

When searching for audio, the minimum duration of the audio assets. If included, must be greater than or equal to 0.

audioMaxDurationSecondsinteger nullable

When searching for audio, the maximum duration of the audio assets. If included, must be greater than or equal to 0.

audioArtiststring

When searching for audio, the artist name of the audio assets.

audioAlbumstring

When searching for audio, the album name of the audio assets.

audioTypesSearchAudioTypeModel[] nullable

When searching for audio, the type of the audio assets.

includedInstanceTypesModelInstanceType[] nullable

When searching for models, this filters that the following Instance types are included in the model.

includeOnlyVerifiedCreatorsboolean

Whether the results should only include assets created by verified creators.

minPriceCentsinteger nullable

The minimum price of the asset in cents. If included, must be greater than or equal to 0.

maxPriceCentsinteger nullable

The maximum price of the asset in cents. If included, must be greater than or equal to 0.

facetsstring[] nullable

Additional keywords to query by.

tagsstring[] nullable

The tags used to filter the results.

categoryPathstring
searchView'IDs' | 'Core' | 'Full'

This view controls which fields are populated in the search response. A lighter view will result in faster response times and higher reliability.

Indicates which fields will be populated in the response.

musicChartType'None' | 'Current' | 'Week' | 'Month' | 'Year'

Represents which music chart to pull entries from, if any

Indicates which music charts to filter from.

swimlanestring

Indicates which swimlane to filter from.

Response

Success

nextPageTokenstring nullable

The page token to view the next page of results.

totalResultsinteger

The total number of results for the given search query.

filteredKeywordstring nullable

The filtered keyword that was used to search for assets, if applicable.