Get Synonyms by Language or Synonym Group

Path segment is overloaded: use a language code (for example en) to list all synonym groups for that language (getSynonymsByLanguage). Use a numeric synonym group ID to fetch a single group (getSynonymGroup).

GET /api/synonymsgroup/{identifier}

Get Synonyms by Language or Synonym Group

cURL

curl --request GET \
  --url https://api.cludo.com/api/synonymsgroup/{identifier} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "groupId": 123,
  "words": [
    "<string>"
  ],
  "language": "<string>"
}

Authorizations

Authorization · string · header · required

Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.

Path Parameters

identifier · string · required

A two-letter ISO language code (e.g. en, da, de) to list all groups for that language, or a numeric group ID to fetch one group. Corresponds to getSynonymsByLanguage (language) and getSynonymGroup (group ID) in client integrations.

Response

200

application/json

Synonym group(s) matching the identifier.

object

object[]

groupId · integer · required

Synonym group ID (assigned by server on create).

words · string[] · required

Equivalents treated as the same intent for search (e.g. motorcycle, bike).

language · string · required

A two-letter ISO language code (e.g. en, da, de) this group applies to.