Search API with Additional Parameters

Filter, page and sort a search by passing the parameters from a response item's URL.

Last updated

On this page

Overview

To search the collection by filter, page or sorting, provide the values in the Search API request. Each filter, active filter and paginator item includes a URL with predefined parameters. To filter data, pass all parameters from that URL to the request body.

When a filter is active, its URL field excludes the filter parameter, which allows deselection. When a filter is selected, its selected field is true.

Example

A filter can have a URL field like this:

TEXT
“/?q=Yoga&category1=11&color=5477&size=5602”

The Search API request body for this filter looks like this:

JSON
{
   "q": "Yoga",
   "token": "{{ website_token }}",
   "category1": "11",
   "color": "5477",
   "size": "5602",
}