---
title: "Retrieve synonym groups"
method: GET
path: "/v1/synonym_groups"
tags: ["Synonym groups"]
---

# Retrieve synonym groups

`GET /v1/synonym_groups`

**🔐 This endpoint requires [HTTP authentication](https://docs.constructor.com/reference/main-authentication) (either [Basic](https://docs.constructor.com/reference/main-authentication#basic-authentication) or [Bearer](https://docs.constructor.com/reference/main-authentication#bearer-authentication)).**
For authenticating with Bearer token, required scopes are: `synonyms(r)`.

Retrieve all synonyms, optionally filtered by phrase.

## Query parameters

- `key` string, required — The key of the index to use.
- `section` string — The section of the index to use. Defaults to `Products`.
- `synonym_group_id` integer[] — A list of synonym group IDs for filter by
- `phrase` string — Phrase to search by
- `num_results_per_page` integer — The number of results per page to return.
- `page` integer — The page of results to return.
- `offset` integer — 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
- `sort_order` 'ascending' | 'descending'
- `c` string — The ID of the client and version that the request is coming from, such as `cio-js-2.90`.

## Response `200`

OK

- SynonymListGetResponse
  - `total_count` integer, required
  - `synonym_groups` SynonymGroupGetResponse[], required
    - `synonyms` string[], required
    - `synonym_group_id` integer, required — The ID of the synonym group, must be unique.
    - `created_at` string, date-time, required — Synonym group creation date in ISO 8601 format
    - `updated_at` string, date-time, required — Last synonym group update date in ISO 8601 format.

## Other 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

---

[API](https://skmtc.dev/constructor/apis/autocomplete.md) · [All operations](https://skmtc.dev/constructor/apis/autocomplete/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/constructor/autocomplete/revisions/2d33330633b6/schema)