---
title: "Returns all synonyms"
method: GET
path: "/synonym"
tags: ["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

- `searchTerm` string
- `types` SynonymTypeApiModel[]
- `isGeneratedByAI` boolean
- `statuses` SynonymStatusApiModel[]
- `limit` integer
- `offset` integer

## Response `200`

OK

- SynonymApiModels: Paginated collection of synonyms
  - `Total` integer, nullable, required: The total number of records which can be retrieved. Note that this field is not available for all paginated endpoints.
  - `Records` SynonymApiModel[], required: The retrieved records.
    - `Id` integer: Id of the synonym
    - `SourceTerm` string, nullable: Sourceterm of the synonym. Used for type oneway synonym
    - `Terms` string[]: Synonym terms
    - `IsGeneratedByAI` boolean: Indicates whether the synonym is generated by AI
    - `Status` 'Pending' | 'Approved' | 'Rejected'
    - `Type` 'OneWay' | 'TwoWay'

---

[API](https://skmtc.dev/tweakwise/apis/app-api.md) - [All operations](https://skmtc.dev/tweakwise/apis/app-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tweakwise/apis/app-api/revisions/dc936bf76941?raw)