v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Synonyms

Retrieve one-way synonyms

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

Retrieve all one-way synonyms.

get/v2/one_way_synonyms

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
parent_phrasestring[]

A list of parent phrases to filter by

[
  "shoes"
]
phrasestring
Example:shoes
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'created_at' | 'updated_at' | 'activated_at'
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

Response

OK

total_countinteger required

Total count of one way synonyms returned