API client / Methods / Synonyms
Required API Key: any key with the settings ACL
Method signature
$index->getSynonym(string objectID)

About this method

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

Get a single synonym object using its synonym ID (objectID).

objectID doesn’t refer to an Algolia record but the unique identifier for a synonym object.

Examples

Read the Algolia CLI documentation for more information.

To retrieve a synonym:

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

Parameters

objectID
type: string
Required

Unique identifier of the synonym you want to retrieve

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

1
2
3
4
5
6
7
8
{
  "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

The parameter value should match the synonym’s type and be one of the following:

  • 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 synonym. A word or expression, 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 corrections parameter.

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 replacements parameter.

replacements
list
Required if type=placeholder

A list of replacements for the placeholder.

Did you find this page helpful?