Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method description

...

The calling user must have the EB_ROOT, EB_ADMIN, EB_APP, SEARCH_ADMIN, SEARCH_MANAGER or SEARCH_ANALYST role for this instance or the global instance.

Parameters

NameRequiredDescription
enabled(error)(error)Filter by enabled/disabled state
lang(error)(error)Filter by synonym language
rows(tick)(tick)See: pagination
offset(tick)(tick)See: pagination

Response format and codes

...

Code Block
languagejs
{
  "num_found": 123,
  "results": [
    {
        "type": "catalog",
        "lang": "en",
        "enabled": true,
        "synonyms": [
            "yellow"
        ],
        "alternatives": [
            "lemon",
            "banana"
        ],
        "extra": {
          "user": "username"
        },
        "batched": false,
        "id": "586c267572c547cdcb51be9c",
        "created_on": "2017-01-03T22:32:21"
        "updated_on": "2017-01-03T22:32:21"
    },
    ...
  ]
}

...