younifyd
Menu

List Subscribers

List subscribers

GET/v2/subscriptions/subscribers

Use it in a workflow

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

Request

Query parameters

filterstring (string)

Some Subscriptions API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.

page[offset]integer (int64)

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.

page[limit]integer (int64)

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.

Response

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

dataarray<object>
idstring (uuid)

The unique identifier.

typestringrequired

One ofsubscription_subscriber

attributesanyrequired
metaobjectrequired3 fields
linksobject
json
{
  "data": [
    {
      "type": "subscription_subscriber",
      "attributes": null,
      "meta": {
        "owner": "store",
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244842Z",
          "created_at": "2017-01-10T11:41:19.244842Z"
        },
        "feature_entitlements": [
          "tag1",
          "tag2"
        ]
      },
      "id": "11111111-2222-3333-4444-555555555555"
    }
  ],
  "links": {}
}

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