EntitySynonym

List the synonyms of one entity type

Returns one page of the synonyms of an entity type, ordered by id, optionally for one entity and one source. Synonyms of deleted entities are left out. Service API key only (chat_api).

get/api/entity-synonyms

Request

Query parameters

entity_type'brand' | 'property' | 'league' | 'agency' | 'venue' | 'market' | 'category' | 'subcategory' | 'asset' required
entity_idinteger
source'manual' | 'admin_link' | 'queue_approval' | 'auto_link' | 'edgar' | 'podcast_scouting' | 'logo_detection' | 'surface'
per_pageinteger
pageinteger

Response

One page of synonyms.

Example response

{
  "data": [
    {
      "id": 7,
      "entity_type": "property",
      "entity_id": 4711,
      "synonym": "Kraken",
      "normalized_synonym": "kraken",
      "source": "surface",
      "confidence": "high"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.