Retrieve searchabilities

get

https://ac.cnstrc.com/v1/searchabilities

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

Retrieve all searchabilities.

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

section

string

length between 1 and 100

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

filters

object

Criteria to narrow the result set by. Different filters from this parameter are ANDed together.

num_results_per_page

integer

1 to 1000

Defaults to 20

The number of results per page to return.

page

integer

≥ 1

The page of results to return.

offset

integer

≥ 0

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

sort_by

string

enum

The criteria by which searchability configurations should be sorted.

Allowed:

sort_order

string

enum

Defaults to ascending

The sort order by which searchability configurations should be sorted. Only valid when used in conjunction with sort_by.

Allowed:

string

length between 1 and 100

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

excludes

object

Criteria to narrow the result set by. Different filters from this parameter are ORed together, and results matching them are excluded

includes

object

Criteria to narrow the result set by. Different filters from this parameter are ORed together.

search_configurable

boolean

Filter only configurable searchabilities.

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

👋 Welcome to Constructor's new and improved documentation

200OK