Get Synonyms Endpoint

Created by Óscar Menéndez · last update March 20, 2020

About this endpoint

Get list of synonyms

Request

Define the request using all the available params and filters detailed in the box.

GET https://api.empathybroker.com/play/v1/INSTANCE_ID/synonyms

Parameter Name Required Description
rows False Number of rows
pkw False Filter by synonym keywords (partial search)
offset False Elements to skip
lang False Filter by synonym language
kw False Filter by synonym keywords (exact search)
enabled False Filter by enabled synonyms

Response

Once the request is performed, the following data is retrieved in json format.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "num_found": 2,
  "results": [
  {
        "alternatives": [],
        "batched": false,
        "created_on": "2020-03-12T17:36:46.000Z",
        "enabled": true,
        "extra": {
          "user": "test@test.com"
        },
        "id": "5e6a732ecb5403000e6354e9",
        "lang": "en_GB",
        "synonyms": [
          "Tweed",
          "Boucle",
          "boucle",
          "tweed"
        ],
        "type": "basic",
        "updated_on": "2020-03-12T17:36:46.000Z"
  },
  {
        "alternatives": [],
        "batched": false,
        "created_on": "2020-03-12T17:36:46.000Z",
        "enabled": true,
        "extra": {
          "user": "test@test.com"
        },
        "id": "5e6a732ecb5403000e6354e9",
        "lang": "en_GB",
        "synonyms": [
          "edited",
          "editable"
        ],
        "type": "basic",
        "updated_on": "2020-03-12T17:36:46.000Z"
  }
  ]
}