Retrieve one-way synonyms

get

https://ac.cnstrc.com/v2/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.

If a parent phrase is provided, only the one-way synonyms associated with the parent phrase for the given key will be returned. If no parent phrase is provided, all parent phrases for the given key will be returned.

The child phrase may contain the automatically_generated flag which indicates whether the phrase was created by the customer or by the Constructor platform.

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

parent_phrase

array of strings

length ≥ 1

A list of parent phrases to filter by

Parent Phrase

phrase

string

length ≥ 1

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

Fields that you can sort the results by

Allowed:

sort_order

string

enum

In which order results are returned

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.

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