Get synonym

Required API Key: any key with the editSettings ACL
Method signature
$index->getSynonym(objectID)
Method signature
index.get_synonym(objectID)
Method signature
index.getSynonym(objectID, callback)
Method signature
index.get_synonym(objectID)
Method signature
This method is not available in mobile API clients.

Synonyms need to be configured via
the Algolia Dashboard or with one of our backend API clients.

Method signature
This method is not available in mobile API clients.

Synonyms need to be configured via
the Algolia Dashboard or with one of our backend API clients.

Method signature
index.GetSynonym(objectID);
Method signature
index.getSynonym(objectID)
Method signature
index.GetSynonym(objectID)
Method signature
get.synonym(objectID).from("index_name")

About this method

Get a single synonym using its object id.

Examples

To retrieve a synonym by objectID:

<?php
$synonym = $index->getSynonym("a-unique-identifier");
synonym = index.get_synonym('a-unique-identifier')
index.getSynonym('a-unique-identifier', function(err, content) {
  if (err) throw err;

  console.error(content);
});
synonym = index.get_synonym('a-unique-identifier')
var synonym = index.GetSynonym("a-unique-identifier");
// Sync version
Optional<AbstractSynonym> synonym =
  index.getSynonym("a-unique-identifier");

// Async version
CompletableFuture<Optional<AbstractSynonym>> synonym =
  index.getSynonym("a-unique-identifier");
synonym, err := index.GetSynonym("a-unique-identifier")
var synonym: Future[Synonym] = client.execute {
    get synonym "a-unique-identifier" from "index_name"
}

Parameters

objectID
type: string
Required

objectID of the synonym you want to retrieve

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

{
  "objectID": "a-unique-identifier",
  "type": "synonym",
  "synonyms": [
    "car",
    "vehicle"
  ]
}
objectID
string
Required for only some languages

Must contain the same value as the objectId above.

type
string
Required

There are 4 synonym types. The parameter can be one of the following values:

  • synonym
  • oneWaySynonym
  • altCorrection1 or altCorrection2
  • placeholder
synonyms
list
Required if type=synonym or type=oneWaySynonym

A list of synonyms.

input
string
Required if type=oneWaySynonym

Defines the 1-way synonym. A single word, used as the basis for the array of synonyms.

word
string
Required if type=altCorrection1 or type=altCorrection2

A single word, used as the basis for the below array of corrections.

corrections
list
Required if type=altCorrection1 or type=altCorrection2

An list of corrections of the word.

placeholder
string
Required if type=placeholder

A single word, used as the basis for the below list of replacements.

replacements
list
Required if type=placeholder

An list of replacements of the placeholder.

Php small white
PHP
Ruby small white
Ruby
Javascript small white
JavaScript
Python small white
Python
Swift small white
iOS
Android small white
Android
Csharp small white
C#
Java small white
Java
Go small white
Go
Scala small white
Scala
Php small white
PHP
Ruby small white
Ruby
Javascript small white
JavaScript
Python small white
Python
Swift small white
iOS
Android small white
Android
Csharp small white
C#
Java small white
Java
Go small white
Go
Scala small white
Scala