---
title: "Retrieve searchabilities (Deprecated)"
method: GET
path: "/v1/searchabilities"
tags: ["Searchabilities"]
deprecated: true
---

# Retrieve searchabilities (Deprecated)

`GET /v1/searchabilities`

## Request

- Base URL: `https://ac.cnstrc.com`
- URL: `https://ac.cnstrc.com/v1/searchabilities`
- Auth: one of:
  - HTTP basic
  - HTTP bearer

> **Deprecated.**

**🔐 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: `searchabilities(r)`.

Retrieve all searchabilities.

## Query parameters

- `key` string, required: The key of the index to use.
- `section` string: The section of the index to use. Defaults to `Products`.
- `filters` SearchabilityFilters
  - `name` string: Name of searchability field.
  - `fuzzy_searchable` boolean: Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.
  - `exact_searchable` boolean: Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.
  - `displayable` boolean: Specifies whether the field is displayable in the response within the `results` array.
- `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`.
- `sort_by` 'name' | 'percentage_presence': The criteria by which searchability configurations should be sorted.
- `sort_order` 'ascending' | 'descending'
- `c` string: The ID of the client and version that the request is coming from, such as `cio-js-2.90`.
- `excludes` SearchabilityFilters
  - `name` string: Name of searchability field.
  - `fuzzy_searchable` boolean: Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.
  - `exact_searchable` boolean: Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.
  - `displayable` boolean: Specifies whether the field is displayable in the response within the `results` array.
- `includes` SearchabilityFilters
  - `name` string: Name of searchability field.
  - `fuzzy_searchable` boolean: Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.
  - `exact_searchable` boolean: Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.
  - `displayable` boolean: Specifies whether the field is displayable in the response within the `results` array.
- `search_configurable` boolean: Filter only configurable searchabilities.

## Response `200`

OK

- SearchabilityListGetResponse
  - `searchabilities` SearchabilityResponse[], required: A list of facet searchabilities configurations.
    - `name` string, required: Name of searchability field.
    - `percentage_presence` number: Percentage of items and variations that contain this field.
    - `fuzzy_searchable` boolean, required: Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.
    - `facetable` boolean, required: Specifies whether the field should be treated as a facet. When True, the metadata field must be a string, float, integer, or list of these types. Dictionaries are supported if they contain values of these types. Nested dictionaries are not supported
    - `exact_searchable` boolean, required: Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.
    - `type` 'number' | 'string' | 'array' | 'object' | 'boolean' | 'mixed'
    - `example_items` string[]: A list of items that has this searchability field.
    - `default` boolean, required: Flag that shows if this searchability config is default.
    - `displayable` boolean, required: Specifies whether the field is displayable in the response within the `results` array.
    - `hidden` boolean, required: Hides the field by default in the response but makes it available to retrieve via `fmt_options[hidden_fields]` parameter.
    - `created_at` string, date-time, required: Creation date and time
    - `updated_at` string, date-time: Last updated date and time
  - `total_count` integer, required: Number of searchabilities.

## 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.dev/constructor/apis/configuration.md) - [All operations](https://skmtc.dev/constructor/apis/configuration/llms.txt) - [OpenAPI document](https://skmtc.dev/constructor/apis/configuration/revisions/205ffdb5f494?raw)