---
title: "Retrieve facet options"
method: GET
path: "/v1/facets/{facet_name}/options"
tags: ["Facets"]
---

# Retrieve facet options

`GET /v1/facets/{facet_name}/options`

**🔐 This endpoint requires [HTTP authentication](https://docs.constructor.com/reference/main-authentication) (either [Basic](https://docs.constructor.com/reference/main-authentication#basic-authentication) or [Bearer](https://docs.constructor.com/reference/main-authentication#bearer-authentication)).**
For authenticating with Bearer token, required scopes are: `facets(r)`.

Retrieve facet options for the given `facet_name`.

## Path parameters

- `facet_name` string, required

## Query parameters

- `key` string, required — The key of the index to use.
- `section` string — The section of the index to use. Defaults to `Products`.
- `num_results_per_page` integer — The number of results per page to return.
- `page` integer — The page of results to return.
- `offset` integer — The number of results to skip from the beginning. Cannot be used together with `page`.
- `c` string — The ID of the client and version that the request is coming from, such as `cio-js-2.90`.
- `filter` FacetOptionListFilters
  - `value_alias` string — Value alias to filter by.

## Response `200`

OK

- FacetOptionListGetResponse
  - `facet_options` FacetOption[], required — A list of facet options.
    - `value` string, required — A value for this facet option. Must be unique for particular facet.
    - `value_alias` string — A value alias. It is used to merge several different but semantically similar facet options into one. For example, 'dark blue' and 'light blue' can be aliased to 'blue'.
    - `replace_value_alias` boolean — Determines the handling of a value alias when present. If set to `true`, exclusively considers the aliased value. If `false`, both the original and the aliased values are used.
    - `display_name` string — A display name for this facet option.
    - `position` integer — Used to order facet options.
    - `data` object — Dictionary with any extra facet option data. Default value is `null`.
    - `hidden` boolean — Specifies whether the facet option is hidden from users.
  - `total_count` integer, required — Total count of facet options.

## Other responses

- `400` — Validation Error
- `401` — Credentials are not passed or action is forbidden.
- `403` — The supplied token does not have the required permissions.
- `429` — Rate limit breached

---

[API](https://skmtc.net/constructor/apis/autocomplete.md) · [All operations](https://skmtc.net/constructor/apis/autocomplete/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/constructor/autocomplete/versions/2d33330633b6/schema)
