Retrieve all subscribers of a list

Get a list of all the subscribers in a list.
Results are paginated, max 50 results per page.

Endpoint

GET /lists/:uuid/subscribers


Required parameters

api_token string
Your api_token.

uuid string
Your list UUID.

Optional parameters

page integer
Page you want to jump to. By default is 1.


Example response

{
  "status": "ok",
  "data": {
    "response": "subscribers_retrieved",
    "subscribers": [
      {
        "id": "sub_1564fabfe0bb",
        "name": "John Doe",
        "email": "john.doe@gmail.com",
        "code": "266-18bc5ad8",
        "position": null,
        "referred": false,
        "referred_by": null,
        "people_referred": 0,
        "promoted": false,
        "points": 1,
        "host": "https://maitreapp.co"
      },
      {
        "id": "sub_c4b925fd621d",
        "name": "Peter Smith",
        "email": "peter.smith@yahoo.com",
        "code": "266-af21f6c1",
        "position": null,
        "referred": false,
        "referred_by": null,
        "people_referred": 0,
        "promoted": false,
        "points": 1,
        "host": "https://maitreapp.co"
      },
      ...
    ],
    "pagination": {
      "total_pages": 1,
      "current_page": 1,
      "per_page": 50,
      "total_objects": 14
    }
  },
  "calls_left": 1000,
  "timestamp": 1487675505
}

Still need help? Contact Us Contact Us