Subscribers | API reference

Basic information

GET /{shopId}/newsletter-campaigns/{campaignId}/subscribers

Returns all subscribers of a newsletter campaign from a shop.

Authorisation

OAuth 2.0 Token required with scopes:

newsletters_read

URI parameters

Name	Type	Description
`shopId`	string	The unique identifier of the shop. Required: `true` Example: `DemoShop`
`campaignId`	string	Required: `true`

Query parameters

Name	Type	Description
`page`	integer	Represents the current page. Required: `false` Default: `1` Minimum: `1`
`resultsPerPage`	integer	Specifies the maximum number of results per page. Required: `false` Default: `10` Maximum: `100`

Response attributes

Name	Type	Description
`results`	integer	The number of subscribers in total.
`page`	integer	The page number on which the subscribers appear.
`resultsPerPage`	integer	The number of subscribers returned per page.
`items`	array of newsletterSubscriber	The list of all subscribers for a newsletter campaign of a shop.

Response

HTTP 200

Media type application/json

{
  "results": 2,
  "page": 1,
  "resultsPerPage": 10,
  "items": [
    {
      "email": "kirsten.greenholt@corkeryfisher.info",
      "name": "Kirsten Greenholt",
      "subscribed": true
    },
    {
      "email": "c.bartell@bartello.de",
      "name": "Christopher Bartello",
      "subscribed": false
    }
  ]
}