Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Collections

Retrieve collections

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: collections(r).

Retrieve all collections. By default, only base collections (collections with no overridden_collection_id) are returned. Use the overridden_collection_id query parameter to retrieve overriding collections for a specific base collection.

get/v1/collections

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
idstring[]

The ID(s) of collections to filter by.

[
  "summer-sale"
]
overridden_collection_idstring

When provided, returns only collections that override the specified collection ID.

Example:summer-sale
querystring

A query to narrow the result set when listing collections. Matches on id or display_name.

Example:sneakers
num_results_per_pageinteger

The number of results per page to return.

Example:20
pageinteger

The page of results to return.

Example:1
offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

sort_by'created_at' | 'updated_at' | 'display_name' | 'start_time' | 'end_time'

The attribute to sort by. Accepted values are 'created_at', 'updated_at', 'display_name', 'start_time', 'end_time'

Example:created_at
sort_order'ascending' | 'descending'
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90
has_future_itemsboolean

When true, only collections that have future items (items not yet in the catalog) will be returned. When false, only collections that do not have future items will be returned.

Response

OK

total_countinteger required

Example response

{
  "collections": [
    {
      "display_name": "Summer Sale",
      "data": {
        "key": "value"
      },
      "matches": [
        {
          "pattern": "summer sale"
        }
      ]
    }
  ]
}