Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Sort options

Retrieve sort options

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

Retrieve all sort options, optionally filtered by sort_by.

get/v1/sort_options

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:50
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_bystring

sort_by field of the sort options that you'd like to retrieve

Example:price
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

Response

OK

total_countinteger required

Example response

{
  "sort_options": [
    {
      "display_name": "Price: Low to High",
      "path_in_metadata": "data.price",
      "position": 1,
      "sort_by": "price"
    }
  ]
}