younifyd
Menu

List Synonym Sets

List synonym sets

GET/pcm/catalogs/search/synonym-sets

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the List Synonym Sets action (under Catalog Search).
  3. Fill in the fields below, then reference the result from later steps as {{listSynonymSets.response.data}}.

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://euwest.api.elasticpath.com/v2https://useast.api.elasticpath.com/v2__custom__Default "https://euwest.api.elasticpath.com/v2"

baseUrlCustomstring
forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

Returns 200 with an object. Read it in later steps with {{listSynonymSets.response.data.<field>}}.

dataarray<object>
idstring (uuid)required

The unique identifier for the synonym set.

typestringrequired

Represents the type of object being returned. Always `catalog_search_synonym_set`.

One ofcatalog_search_synonym_set

attributesobjectrequired2 fields
metaobjectrequired5 fields
metaobject
resultsobjectrequired1 fields

Contains the results for the entire collection.

json
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "catalog_search_synonym_set",
      "attributes": {
        "name": "Apparel terms",
        "items": [
          {
            "id": "footwear-terms",
            "synonyms": [
              "sneakers",
              "trainers",
              "running shoes"
            ],
            "root": "jacket",
            "locale": "en",
            "symbols_to_index": [
              "-"
            ]
          }
        ]
      },
      "meta": {
        "created_at": "2026-03-05T12:00:00Z",
        "updated_at": "2026-03-05T12:00:00Z",
        "owner": "organization",
        "sync_status": "pending_sync",
        "last_synced_at": "2026-03-05T12:01:00Z"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 100
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.