---
title: "List the synonyms of one entity type"
method: GET
path: "/api/entity-synonyms"
tags: ["EntitySynonym"]
---

# List the synonyms of one entity type

`GET /api/entity-synonyms`

## Request

- Base URL: `https://api.sponsorunited.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sponsorunited.com/api/entity-synonyms`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/sponsorunited/apis/sponsorunited-api/docs/api/entity-synonyms/get.ts> (a function with typed inputs; its response is checked against the schema)

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).

## Query parameters

- `entity_type` 'brand' | 'property' | 'league' | 'agency' | 'venue' | 'market' | 'category' | 'subcategory' | 'asset', required
- `entity_id` integer
- `source` 'manual' | 'admin_link' | 'queue_approval' | 'auto_link' | 'edgar' | 'podcast_scouting' | 'logo_detection' | 'surface'
- `per_page` integer
- `page` integer

## Response `200`

One page of synonyms.

- object
  - `data` EntitySynonymResource[]
    - `id` integer
    - `entity_type` 'brand' | 'property' | 'league' | 'agency' | 'venue' | 'market' | 'category' | 'subcategory' | 'asset'
    - `entity_id` integer
    - `synonym` string
    - `normalized_synonym` string, nullable: The synonym normalized for matching; each normalized name belongs to one entity of the type.
    - `source` 'manual' | 'admin_link' | 'queue_approval' | 'auto_link' | 'edgar' | 'podcast_scouting' | 'logo_detection' | 'surface'
    - `confidence` 'high' | 'medium' | 'low', nullable
    - `matched_at` string, date-time, nullable

## Other responses

- `401`: Unauthenticated
- `403`: The caller is not one of the allowed services.
- `422`: Validation error.

---

[API](https://skmtc.dev/sponsorunited/apis/sponsorunited-api.md) - [All operations](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/revisions/cbf1ca5bff8f?raw)