Get synonyms

GET /indexes/{indexUid}/settings/synonyms
Api key

Get the list of synonyms of an index.

Path parameters

  • indexUid string Required

    Index Unique Identifier

Responses

  • • 200 application/json

    Ok

    List of associated words treated similarly. A word associated to an array of word as synonyms.
  • • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
  • • 404

    Not Found

GET /indexes/{indexUid}/settings/synonyms 
curl \
 -X GET https://example.meilisearch.com:7700/indexes/movies/settings/synonyms \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "wolverine": [
    "xmen",
    "logan"
  ],
  "logan": [
    "wolverine",
    "xmen"
  ],
  "wow": [
    "world of warcraft"
  ]
}
Response examples (401) 
{
  "message": "The Authorization header is missing. It must use the bearer authorization method.",
  "code": "missing_authorization_header",
  "type": "auth",
  "link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}