v1

latestOpenAPI 3.1.02026-07-241765501.1 MB

Searchabilities

Retrieve searchabilities

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: searchabilities(r).

Retrieve all searchabilities.

get/v2/searchabilities

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

sectionstring

The section of the index to use. Defaults to Products.

Example:Products

num_results_per_pageinteger

The number of results per page to return.

Example:20

pageinteger

The page of results to return.

Example:1

offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

sort_by'name'

The criteria by which searchability configurations should be sorted.

Example:name

sort_order'ascending' | 'descending'

match_type'and' | 'or'

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

exact_searchableboolean

Specifies whether the searchability is exact_searchable.

fuzzy_searchableboolean

Specifies whether the searchability is fuzzy_searchable.

Example:true

displayableboolean

Specifies whether the field is displayable.

Example:true

namestring

Name of searchability field to filter for. Supports exact matching (name=value) and substring matching (name=*value, value* or *value*).

Example:brand

Response

total_countinteger required

Number of searchabilities.