Get synonym

Retrieve a single synonym object using its object ID.

Required ACL: settings

Examples

C#

Synonym synonym = index.GetSynonym("synonymID");

// Asynchronous
Synonym synonym = index.GetSynonymAsync("synonymID");

synonym, err := index.GetSynonym("synonymID")

Synonym synonym = index.getSynonym("synonymID");

// Async version
CompletableFuture<Synonym> synonym = index.getSynonym("synonymID");

index.getSynonym('synonymID').then(synonym => {
  console.log(synonym);
});

index.getSynonym(ObjectID("synonymID"))

$synonym = $index->getSynonym("synonymID");

synonym = index.get_synonym('synonymID')

synonym = index.get_synonym('synonymID')

var synonym: Future[Synonym] = client.execute {
    get synonym "synonymID" from "index_name"
}

index.getSynonym(withID: "synonymID") { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Parameters

objectID · string · required

Unique identifier of the synonym you want to retrieve.

Response

corrections · string[]

List of corrections. (For synonym types altCorrection1 or altCorrection2).

input · string

A word used as the basis for synonyms. (For synonym type oneWaySynonym).

objectID · string

The object ID of the retrieved synonym.

placeholder · string

A word used as the basis for replacements. (For synonym type placeholder).

replacements · string[]

List of replacements for the placeholder. (For synonym type placeholder).

synonyms · string[]

List of synonyms. (For synonym types synonym or oneWaySynonym).

type · string

Synonym type. One of:

• altCorrection1
• altCorrection2
• oneWaySynonym
• placeholder
• synonym

word · string

A word used as the basis for corrections. (For synonym types altCorrection1 or altCorrection2).

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

{
  "objectID": "a-unique-identifier",
  "type": "synonym",
  "synonyms": [
    "car",
    "vehicle"
  ]
}