Subscriber API

Subscribers of the profile or store can be accessed through the Subscriber API. This API provides the subscriber's email address and the date of their subscription. The subscriber details can then be forwarded to different marketing platforms for marketing or newsletter campaigns.

In order to access the next page, make use of page parameters.

http://api.shopper.com/v1/user/subscribers?page={page}&limit={limit}&order_by={order_by}

Parameters

Sample Response

{
    "status": 200,
    "message": "OK",
    "current": 1,
    "start": 1,
    "end": 1,
    "limit": 200,
    "total": 10,
    "next_page": "https://api.shopper.com/v1/user/subscribers?page=2&limit=200",
    "subscribers": [
        {
            "id": "625535caefdfcd0019074899",
            "email": "happy@happy.com",
            "subscribe_date": "2022-04-12T08:18:18.665Z"
        },
        {
            "id": "6255372fefdfcd001907489a",
            "email": "happy2@happy.com",
            "subscribe_date": "2022-04-12T08:24:15.194Z"
        }
    ]
}

Response body

subscribers: Array of subscriber for the authenticated store, including unique subscriber id, email and subscribed date in ISO 8601 format

Response status