Detail of e-mail distribution list

Request

This endpoint returns a list of e-mail addresses of the distribution list.

Upon initial call, it returns up to 500 e-mail addresses; using the ?itemsPerPage=20 parameter, you can requests any number of records per page, up to 500 items limit.

Endpoint supports Paging.

Security

shoptetAccessToken or shoptetPrivateApiToken

Path

codestringrequired

e-mail list code

Example:newsletters

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/mailing-lists/newsletters \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

dataobjectrequired

errorsArray of objects or null(Errors)required

metadataobject(Metadata)required

Response

{
  "data": {
    "emails": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}