API Reference / API Methods / Synonyms / Export Synonyms

Export Synonyms

Required API Key: any key with the settings ACL
Method signature
$index->browseSynonyms()

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

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.

Examples

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

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

Parameters

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

Index name.

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

A mapping of request options to send along with the query.

Response

Returns a synonym iterator.

Did you find this page helpful?