Get all synonym sets

GET /_synonyms

Auth

Get a summary of all defined synonym sets.

Required privileges

Cluster privileges manage_search_synonyms

Query parameters

from number · default: 0: The starting offset for synonyms sets to retrieve.
size number · default: 10: The maximum number of synonyms sets to retrieve.

Response

application/json

count number required: The total number of synonyms sets defined.
results object[] required: The identifier and total number of defined synonym rules for each synonyms set.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _synonyms

JavaScript Elasticsearch JavaScript Client

const response = await client.synonyms.getSynonymsSets();

Python Elasticsearch Python Client

resp = client.synonyms.get_synonyms_sets()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_synonyms" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.synonyms().getSynonymsSets(g -> g);

C# Elasticsearch .NET Client

var response = await client.Synonyms.GetSynonymsSetsAsync();

PHP Elasticsearch PHP Client

$resp = $client->synonyms()->getSynonymsSets();

Ruby Elasticsearch Ruby Client

response = client.synonyms.get_synonyms_sets

Response

A successful response from GET _synonyms.

{
  "count": 3,
  "results": [
    {
      "synonyms_set": "ecommerce-synonyms",
      "count": 2
    },
    {
      "synonyms_set": "my-synonyms-set",
      "count": 3
    },
    {
      "synonyms_set": "new-ecommerce-synonyms",
      "count": 1
    }
  ]
}