Skip to content

Search Synonym Detail ​

Returns a single search-synonym group with its full field set — the data behind the admin Marketing → Search & SEO → Search Synonyms view screen.

New here? Read the Search Synonyms overview for what a search synonym is and how its fields behave.

Endpoint ​

EndpointMethod
/api/admin/marketing/search-synonyms/{id}GET

Details ​

  • Requires an admin Bearer token in the Authorization header.
  • An unknown id returns a 404.

Response fields ​

FieldTypeNotes
idintNumeric id
namestringGroup name
termsstringComma-separated list of interchangeable search words
createdAtstringCreation timestamp
updatedAtstringLast-update timestamp

Released under the MIT License.