TWtweakwise
Synonym

Returns all synonyms

get/synonym

Request

  • The document declares no server URL.
  • Auth
    API key in header TWN-InstanceKey and API key in header TWN-Authentication

Query parameters

searchTermstring

Search for the string in both the terms and source term

typesSynonymTypeApiModel[]

Indicated whether the synonym is an one-way or two-way synonym

isGeneratedByAIboolean

Indicates whether the synonym is generated by AI

statusesSynonymStatusApiModel[]

Indicates the status of the synonym

limitinteger

The maximum number of records which should be retrieved. You cannot retrieve more than 100 records in a single call. By default, the limit is 20.

offsetinteger

The number of records which should be skipped.

Response

OK

Totalinteger nullable required

The total number of records which can be retrieved. Note that this field is not available for all paginated endpoints.

Changes

No recorded changes to this operation across all 1 revision of this API.