Get a synonym set | Elasticsearch API (v8)

Get a synonym set Added in 8.10.0

GET /_synonyms/{id}

Path parameters

id string Required

"The id of the synonyms set to be retrieved

Query parameters

from number

Starting offset for query rules to be retrieved
size number

specifies a max number of query rules to retrieve

Responses

200 application/json
Hide response attributes Show response attributes object
- count number Required
- synonyms_set array[object] Required
  
  Hide synonyms_set attributes Show synonyms_set attributes object
  
  id string Required
  
  synonyms string Required

GET /_synonyms/{id}

curl \
 -X GET http://api.example.com/_synonyms/{id}

Response examples (200)

{
  "count": 42.0,
  "synonyms_set": [
    {
      "id": "string",
      "synonyms": "string"
    }
  ]
}