List Search Synonyms
Lists every search-synonym group in the store — the data behind the admin Marketing → Search & SEO → Search Synonyms datagrid.
TIP
New here? Read the Search Synonyms overview for what a search synonym is and how its fields behave.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/marketing/search-synonyms | GET |
Response envelope
Admin collections return a { data, meta } body envelope:
data— the search-synonym rows for this page.meta—currentPage,perPage,lastPage,total,from,to.
Query parameters
| Parameter | Description |
|---|---|
page, per_page | Pagination (per_page default 10, max 50) |
name | Group name — partial match |
terms | Contained terms — partial match |
sort, order | Sort field (id, name) + asc / desc (default id desc) |
Filters compose with logical AND — more filters narrow the result.
Every /api/admin/* request requires an admin Bearer token.