---
title: "Get list of the possible facets for a given query"
method: GET
path: "/facets/{facets}"
tags: ["Product List Page"]
---

# Get list of the possible facets for a given query

`GET /facets/{facets}`

Lists the possible facets for a given query

## Path parameters

- `facets` string, nullable, required

## Query parameters

- `query` string
- `locale` string, nullable
- `hideUnavailableItems` boolean

## Response `200`

List of facets for the given query.

- Facets
  - `breadcrumb` object[] — Generated breadcrumb for the given query.
    - `href` string — Query link.
    - `name` string — Human-readable format of the facet key.
  - `facets` object[] — List of facets
    - `hidden` boolean — Whether the client-side should hide the facet (`true`) or not (`false`)
    - `name` string — Human-readable format of the facet key.
    - `quantity` number — Number of possible values.
    - `type` 'TEXT' | 'PRICERANGE' — Facet type - `TEXT` - The value is a simple text. - `PRICERANGE` - The value contains the property `range` representing the minimum and the maximum price for the query.
    - `values` object[] — Possible values.
      - `id` string — Value id
      - `key` string — Facet key.
      - `name` string — Human-readable format of the facet value
      - `quantity` number — Number of resulting products.
      - `selected` boolean — Whether the value is selected (`true`) or not (`false`).
      - `value` string — Facet value.
  - `queryArgs` object — Term and facets used in the query
    - `query` string — Search term used in the query.
    - `selectedFacets` object[] — Facets used in the query.
      - `key` string — facet key.
      - `value` string — facet value.
  - `sampling` boolean — Indicates whether there was sampling in the aggregation of facets or not. In search results that have many products, only the first 30000 will be aggregated to avoid performance issues.

---

[API](https://skmtc.net/vtex/apis/intelligent-search-api.md) · [All operations](https://skmtc.net/vtex/apis/intelligent-search-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/intelligent-search-api/versions/a61de494fbe4/schema)