--- title: "Search Creator Store Assets" method: GET path: "/toolbox-service/v2/assets:search" tags: ["Assets", "Creator Store"] --- # Search Creator Store Assets `GET /toolbox-service/v2/assets:search` Search Creator Store for assets. ## 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. - `query` string - `modelSubTypes` ModelSubType[], nullable - `excludedModelSubTypes` ModelSubType[], nullable - `creator` string - `userId` integer, nullable - `groupId` integer, nullable - `pageToken` string - `pageNumber` integer, nullable - `maxPageSize` integer - `sortDirection` 'None' | 'Ascending' | 'Descending' — Represents the direction in which to sort the results - `sortCategory` 'Relevance' | 'Trending' | 'Top' | 'AudioDuration' | 'CreateTime' | 'UpdatedTime' | 'Ratings' — The category to sort the search results by. - `audioMinDurationSeconds` integer - `audioMaxDurationSeconds` integer, nullable - `audioArtist` string - `audioAlbum` string - `audioTypes` SearchAudioTypeModel[], nullable - `includedInstanceTypes` ModelInstanceType[], nullable - `includeOnlyVerifiedCreators` boolean - `minPriceCents` integer, nullable - `maxPriceCents` integer, nullable - `facets` string[], nullable - `tags` string[], nullable - `categoryPath` string - `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. - `musicChartType` 'None' | 'Current' | 'Week' | 'Month' | 'Year' — Represents which music chart to pull entries from, if any - `swimlane` string ## Response `200` Success - SearchCreatorStoreAssetsResponse, nullable — The response for the SearchCreatorStoreAssets endpoint. - `nextPageToken` string, nullable — The page token to view the next page of results. - `queryFacets` QueryFacets, nullable — The facets of a query. - `appliedFacets` string[], nullable — Facets that are already applied to the search. - `availableFacets` string[], nullable — The unused and still available facets. - `creatorStoreAssets` CreatorStoreAsset[], nullable — The list of creator store assets returned by the search query. - `voting` VotingModel, nullable — model for voting. - `showVotes` boolean — Gets or sets show votes. - `upVotes` integer — Gets or sets success. - `downVotes` integer — Gets or sets down votes. - `canVote` boolean — Gets or sets can vote. - `userVote` boolean, nullable — Gets or sets user vote. - `hasVoted` boolean — Gets UserVote. - `voteCount` integer — The total number of votes - `upVotePercent` integer — The percentage of total votes that have been UpVotes - `creator` CreatorModelV2, nullable — Model representing a creator. - `creator` string, nullable — Deprecated: Please refer to the 'userId' and 'groupId' properties instead. The creator type and ID. E.g. user/123 or group/456. - `userId` integer, nullable — The User ID of the creator. Required if the asset is individual-user-owned. - `groupId` integer, nullable — The Group ID. Required if the asset is group-owned. - `name` string, nullable — The creator's name. - `verified` boolean, nullable — Whether the creator is verified. - `latestGroupUpdaterUserId` integer, nullable — This value only exists for group-based creators and represents the User ID of the creator who most recently updated the asset. - `latestGroupUpdaterUserName` string, nullable — This value only exists for group-based creators and represents the name of the creator who most recently updated the asset. - `creatorStoreProduct` ToolboxServiceCreatorStoreProduct, nullable — The asset's creator store product information. - `purchasePrice` ToolboxServiceMoney, nullable - `currencyCode` string, nullable - `quantity` ToolboxServiceDecimal, nullable - `significand` integer - `exponent` integer - `purchasable` boolean — Whether or not the asset can be purchased in the Creator Store. - `asset` union — The asset information. - ToolboxServiceAsset, nullable — Representation of an asset. - `id` integer — The unique identifier of the asset. - `name` string, nullable — The name of the asset. - `description` string, nullable — The description of the asset. - `assetTypeId` integer, nullable — The type that the asset belongs to. - `socialLinks` SocialLinkModel[], nullable — The social links associated with the asset. - `linkType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `url` string, nullable — Gets or sets the Url. - `title` string, nullable — Gets or sets the title. - `previewAssets` PreviewAssetsModel, nullable — Grouped preview asset ids for an item, separated by media type. - `imagePreviewAssets` integer[], nullable — Ordered list of image preview asset ids. - `videoPreviewAssets` integer[], nullable — Ordered list of video preview asset ids. - `createTime` string, date-time, nullable — The time the asset was created. - `updateTime` string, date-time, nullable — The time the asset was last updated. - `creatingUniverseId` integer, nullable — Universe ID if the asset was created within a specific universe. - `categoryPath` string, nullable — Category Path of the asset, if it exists. e.g. "3d__characters" - Audio, nullable — Representation of an asset. - `id` integer — The unique identifier of the asset. - `name` string, nullable — The name of the asset. - `description` string, nullable — The description of the asset. - `assetTypeId` integer, nullable — The type that the asset belongs to. - `socialLinks` SocialLinkModel[], nullable — The social links associated with the asset. - `linkType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `url` string, nullable — Gets or sets the Url. - `title` string, nullable — Gets or sets the title. - `previewAssets` PreviewAssetsModel, nullable — Grouped preview asset ids for an item, separated by media type. - `imagePreviewAssets` integer[], nullable — Ordered list of image preview asset ids. - `videoPreviewAssets` integer[], nullable — Ordered list of video preview asset ids. - `createTime` string, date-time, nullable — The time the asset was created. - `updateTime` string, date-time, nullable — The time the asset was last updated. - `creatingUniverseId` integer, nullable — Universe ID if the asset was created within a specific universe. - `categoryPath` string, nullable — Category Path of the asset, if it exists. e.g. "3d__characters" - Decal, nullable — Representation of an asset. - `id` integer — The unique identifier of the asset. - `name` string, nullable — The name of the asset. - `description` string, nullable — The description of the asset. - `assetTypeId` integer, nullable — The type that the asset belongs to. - `socialLinks` SocialLinkModel[], nullable — The social links associated with the asset. - `linkType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `url` string, nullable — Gets or sets the Url. - `title` string, nullable — Gets or sets the title. - `previewAssets` PreviewAssetsModel, nullable — Grouped preview asset ids for an item, separated by media type. - `imagePreviewAssets` integer[], nullable — Ordered list of image preview asset ids. - `videoPreviewAssets` integer[], nullable — Ordered list of video preview asset ids. - `createTime` string, date-time, nullable — The time the asset was created. - `updateTime` string, date-time, nullable — The time the asset was last updated. - `creatingUniverseId` integer, nullable — Universe ID if the asset was created within a specific universe. - `categoryPath` string, nullable — Category Path of the asset, if it exists. e.g. "3d__characters" - MeshPart, nullable — Representation of an asset. - `id` integer — The unique identifier of the asset. - `name` string, nullable — The name of the asset. - `description` string, nullable — The description of the asset. - `assetTypeId` integer, nullable — The type that the asset belongs to. - `socialLinks` SocialLinkModel[], nullable — The social links associated with the asset. - `linkType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `url` string, nullable — Gets or sets the Url. - `title` string, nullable — Gets or sets the title. - `previewAssets` PreviewAssetsModel, nullable — Grouped preview asset ids for an item, separated by media type. - `imagePreviewAssets` integer[], nullable — Ordered list of image preview asset ids. - `videoPreviewAssets` integer[], nullable — Ordered list of video preview asset ids. - `createTime` string, date-time, nullable — The time the asset was created. - `updateTime` string, date-time, nullable — The time the asset was last updated. - `creatingUniverseId` integer, nullable — Universe ID if the asset was created within a specific universe. - `categoryPath` string, nullable — Category Path of the asset, if it exists. e.g. "3d__characters" - Model, nullable — Representation of an asset. - `id` integer — The unique identifier of the asset. - `name` string, nullable — The name of the asset. - `description` string, nullable — The description of the asset. - `assetTypeId` integer, nullable — The type that the asset belongs to. - `socialLinks` SocialLinkModel[], nullable — The social links associated with the asset. - `linkType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `url` string, nullable — Gets or sets the Url. - `title` string, nullable — Gets or sets the title. - `previewAssets` PreviewAssetsModel, nullable — Grouped preview asset ids for an item, separated by media type. - `imagePreviewAssets` integer[], nullable — Ordered list of image preview asset ids. - `videoPreviewAssets` integer[], nullable — Ordered list of video preview asset ids. - `createTime` string, date-time, nullable — The time the asset was created. - `updateTime` string, date-time, nullable — The time the asset was last updated. - `creatingUniverseId` integer, nullable — Universe ID if the asset was created within a specific universe. - `categoryPath` string, nullable — Category Path of the asset, if it exists. e.g. "3d__characters" - Music, nullable — Representation of an asset. - `id` integer — The unique identifier of the asset. - `name` string, nullable — The name of the asset. - `description` string, nullable — The description of the asset. - `assetTypeId` integer, nullable — The type that the asset belongs to. - `socialLinks` SocialLinkModel[], nullable — The social links associated with the asset. - `linkType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `url` string, nullable — Gets or sets the Url. - `title` string, nullable — Gets or sets the title. - `previewAssets` PreviewAssetsModel, nullable — Grouped preview asset ids for an item, separated by media type. - `imagePreviewAssets` integer[], nullable — Ordered list of image preview asset ids. - `videoPreviewAssets` integer[], nullable — Ordered list of video preview asset ids. - `createTime` string, date-time, nullable — The time the asset was created. - `updateTime` string, date-time, nullable — The time the asset was last updated. - `creatingUniverseId` integer, nullable — Universe ID if the asset was created within a specific universe. - `categoryPath` string, nullable — Category Path of the asset, if it exists. e.g. "3d__characters" - Plugin, nullable — Representation of an asset. - `id` integer — The unique identifier of the asset. - `name` string, nullable — The name of the asset. - `description` string, nullable — The description of the asset. - `assetTypeId` integer, nullable — The type that the asset belongs to. - `socialLinks` SocialLinkModel[], nullable — The social links associated with the asset. - `linkType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `url` string, nullable — Gets or sets the Url. - `title` string, nullable — Gets or sets the title. - `previewAssets` PreviewAssetsModel, nullable — Grouped preview asset ids for an item, separated by media type. - `imagePreviewAssets` integer[], nullable — Ordered list of image preview asset ids. - `videoPreviewAssets` integer[], nullable — Ordered list of video preview asset ids. - `createTime` string, date-time, nullable — The time the asset was created. - `updateTime` string, date-time, nullable — The time the asset was last updated. - `creatingUniverseId` integer, nullable — Universe ID if the asset was created within a specific universe. - `categoryPath` string, nullable — Category Path of the asset, if it exists. e.g. "3d__characters" - SoundEffect, nullable — Representation of an asset. - `id` integer — The unique identifier of the asset. - `name` string, nullable — The name of the asset. - `description` string, nullable — The description of the asset. - `assetTypeId` integer, nullable — The type that the asset belongs to. - `socialLinks` SocialLinkModel[], nullable — The social links associated with the asset. - `linkType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 - `url` string, nullable — Gets or sets the Url. - `title` string, nullable — Gets or sets the title. - `previewAssets` PreviewAssetsModel, nullable — Grouped preview asset ids for an item, separated by media type. - `imagePreviewAssets` integer[], nullable — Ordered list of image preview asset ids. - `videoPreviewAssets` integer[], nullable — Ordered list of video preview asset ids. - `createTime` string, date-time, nullable — The time the asset was created. - `updateTime` string, date-time, nullable — The time the asset was last updated. - `creatingUniverseId` integer, nullable — Universe ID if the asset was created within a specific universe. - `categoryPath` string, nullable — Category Path of the asset, if it exists. e.g. "3d__characters" - `totalResults` integer — The total number of results for the given search query. - `queryCorrection` QueryCorrection, nullable — Contains query correction information for a search query. - `suggestedQuery` string, nullable — The suggested spelling correction for the original search query. - `filteredKeyword` string, nullable — The filtered keyword that was used to search for assets, if applicable. ## Other responses - `400` — Bad Request - `429` — Too Many Requests - `500` — Server Error --- [API](https://skmtc.net/roblox/apis/roblox-api.md) · [All operations](https://skmtc.net/roblox/apis/roblox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/roblox/roblox-api/versions/e15802062270/schema)