v1

latestOpenAPI 3.1.02026-07-241765501.1 MB

Synonym groups

Retrieve synonym groups

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

Retrieve all synonyms, optionally filtered by phrase.

get/v1/synonym_groups

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

synonym_group_idinteger[]

A list of synonym group IDs for filter by

[
  1
]

phrasestring

Phrase to search by

Example:milk

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'id' | 'created_at' | 'updated_at'

Fields that you can sort the results by

Example:id

sort_order'ascending' | 'descending'

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

total_countinteger required