ROroblox
Creator Store

Gets saves from a collection.

Changed on
get/toolbox-service/v1/saves

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/toolbox-service/v1/saves
  • Auth
    • API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: creator-store-save:read

Query parameters

targetType'Audio' | 'Place' | '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 filter by

targetIdinteger nullable

The ID of the asset to filter by. If provided, targetType must also be provided.

collectionNamestring

Custom collections are not currently supported. This field should be omitted.

sortBy'Name' | 'Creator' | 'Ratings' | 'TargetType' | 'DateSaved' | 'LastModified' | 'Price'

The category to sort the saves by.

The field to sort by

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

Represents the direction in which to sort the results

The direction to sort by

limitinteger

The maximum number of saves to return

pageinteger

The page number to return, starting from 1

keywordstring

The keyword to filter by

hideOwnedAssetsboolean

Whether to hide owned assets

Response

OK

totalCountinteger required

The total number of saves that match the query.

Changes

  • 5dcfa33df56aRevision changes
    • info

      added the enum value Place to the property allOf[SearchCategoryType]/ of the query request parameter targetType

  • ddc1ae212d79Revision changes
    • info

      the response property // became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property //////////// became required for the status

    • info

      the response property //////////// became required for the status

    • info

      the response property //////////// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status