List Contextual Filters

GET

https://api.bigcommerce.com/stores/:store_hash/v3/settings/search/filters/contexts

GET

/stores/:store_hash/v3/settings/search/filters/contexts

curl https://api.bigcommerce.com/stores/store_hash/v3/settings/search/filters/contexts \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Retrieved

{
  "data": [
    {
      "context": {
        "category_id": 1,
        "channel_id": 1
      },
      "data": [
        {
          "collapsed_by_default": true,
          "display_name": "string",
          "display_product_count": true,
          "id": "string",
          "is_enabled": true,
          "items_to_show": 5,
          "sort_by": "alpha",
          "type": "product"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "count": 5,
      "current_page": 1,
      "links": {
        "current": "?limit=5&page=1",
        "next": "?limit=5&page=2"
      },
      "per_page": 5,
      "total": 246,
      "total_pages": 50
    }
  }
}

Returns a list of contextual filters enabled for a particular channel or category.

Usage Notes

Contextual filters allow you to configure the enabled filters per channel or category, so that shoppers can filter by the most relevant criteria.

The order of the returned filters will match the sort order of the filters on the storefront.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

NOTE: Analytics endpoints require the Content (store_v2_content and store_v2_content_read_only) OAuth scope.

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

channel_idintegerOptional

Only return contextual overrides related to a particular Channel.

category_idintegerOptional

Only return contextual overrides related to a particular Category.

Response

datalist of objectsOptional

metaobjectOptional