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

# Retrieve searchability (Deprecated)

`GET /v1/searchabilities/{name}`

## Request

- Base URL: `https://ac.cnstrc.com`
- URL: `https://ac.cnstrc.com/v1/searchabilities/{name}`
- 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 searchability with specified `name`.

## Path parameters

- `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`.
- `c` string: The ID of the client and version that the request is coming from, such as `cio-js-2.90`.

## Response `200`

OK

- SearchabilityGetResponse
  - `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

## Other responses

- `400`: Validation Error
- `401`: Credentials are not passed or action is forbidden.
- `403`: The supplied token does not have the required permissions.
- `404`: Not Found
- `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)