List Enabled Filters

GET

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

GET

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

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

200example-1

{
  "data": [
    {
      "collapsed_by_default": false,
      "display_name": "Size",
      "display_product_count": true,
      "id": "U123=",
      "is_enabled": true,
      "items_to_show": 10,
      "sort_by": "alpha",
      "type": "product"
    },
    {
      "collapsed_by_default": false,
      "display_name": "Brand",
      "display_product_count": true,
      "id": "235fc3dg67",
      "is_enabled": true,
      "items_to_show": 15,
      "sort_by": "alpha",
      "type": "brand"
    },
    {
      "collapsed_by_default": false,
      "display_name": "Color",
      "display_product_count": true,
      "id": "25DtbA=",
      "is_enabled": true,
      "items_to_show": 10,
      "sort_by": "alpha",
      "type": "product"
    },
    {
      "collapsed_by_default": true,
      "display_name": "Ships for Free",
      "display_product_count": false,
      "id": "Ym329vbA==",
      "is_enabled": true,
      "show_free_shipping_filter": true,
      "show_in_stock_filter": true,
      "show_is_featured_filter": true,
      "type": "other"
    }
  ],
  "meta": {}
}

Returns a list of enabled default Product Filtering filters. These filters will be used if a store does not have contextual overrides.

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.

Response

datalist of objectsOptional

metaobjectOptional

Response metadata.

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Response