API Reference / API Methods / Synonyms / Export Synonyms
Required API Key: any key with the settings ACL
Method signature
$index->browseSynonyms()

About this method # A

Retrieve an index’s complete list of synonyms.

The list includes all synonyms - whether created on the dashboard or pushed by the API.

The method returns an iterator.

You can batch import and export synonyms from the dashboard with a configuration file.

Examples # A

1
2
3
4
5
$iterator = $index->browseSynonyms();

foreach ($iterator as $synonym) {
    var_dump($synonym);
}

Parameters # A

indexName #
type: string
only needed in go, scala, c#

Index name.

requestOptions #
type: key/value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the query.

Response # A

Returns a synonym iterator.

Did you find this page helpful?
PHP v3