List Search Indexes

List search indexes

GET/pcm/catalogs/search-indexes

Use it in a workflow

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

Request

Query parameters

out_of_syncboolean

Filter search indexes by out of sync status

Response

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

dataarray<object>

idstring (uuid)required

The unique identifier for the search index.

typestringrequired

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

One ofcatalog_search_index

metaobjectrequired4 fields

metaobject

resultsobjectrequired1 fields

Contains the results for the entire collection.

json

{
  "data": [
    {
      "id": "805103ff-0a37-4f83-8fe0-95a16039bd98",
      "type": "catalog_search_index",
      "meta": {
        "catalog_id": "ac107ce9-96ac-4bd5-aa3d-59f40b91279b",
        "release_id": "b2ddd253-d9bd-4344-a18b-581c1e0b25f8",
        "out_of_sync": false,
        "owner": "organization"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 100
    }
  }
}

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

Was this page helpful?