Campaigns

List CampaignContents

Returns a paginated list of content records for the given Campaign.

get/shop/customers/campaigns/{campaignId}/contents

Query parameters

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

localestring

Filters content records for the given locale code.

querystring

Filters content records whose subject or body contains the given value.

Response

The campaign contents were successfully retrieved.

Example response

{
  "data": [
    {
      "locale": "en-GB",
      "subject": "Exclusive summer offer just for you 🌞",
      "content": "<p>Hi there! We have a special offer just for you.</p>"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.