List Integrations

List integrations

GET/integrations

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the List Integrations action (under Integrations).
Fill in the fields below, then reference the result from later steps as {{listIntegrations.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 {{listIntegrations.response.data.<field>}}.

dataarray<any>

linksobject

Links are used to allow you to move between pages.

firststring

Always the first page. This is not present on the first page.

laststring

This is not present if there is only one page.

nextstring

This is not present if there is no next page.

prevstring

This is not present on the first page.

resultsobject

The results for this response for the entire collection.

totalinteger

The total number of records for this response for the entire collection.

json

{
  "data": [
    null
  ],
  "links": {
    "first": "/integrations?page[offset]=0&page[limit]=10",
    "last": "/integrations?page[offset]=20&page[limit]=10",
    "next": "/integrations?page[offset]=10&page[limit]=10",
    "prev": "/integrations?page[offset]=8&page[limit]=10"
  },
  "results": {
    "total": 1
  }
}

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

Was this page helpful?