Retrieve all lists

Get a list of all the lists for your account.
Results are paginated, max 10 results per page.
NOTE: Only active lists will be retrieved.

Endpoint

GET /lists


Required parameters

api_token string
Your api_token.

Optional parameters

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


Example response

{
  "status": "ok",
  "data": {
    "response": "lists_retrieved",
    "lists": [
      {
        "uuid": "MFae3b657302",
        "name": "My amazing sweepstake",
        "type": "sweepstake",
        "created_at": 1487347070,
        "subscribers": 0
      },
      {
        "uuid": "MF9475c768b4",
        "name": null,
        "type": "waitlist",
        "created_at": 1487347032,
        "subscribers": 12889
      },
      ...
    ],
    "pagination": {
      "total_pages": 7,
      "current_page": 1,
      "per_page": 10,
      "total_objects": 67
    }
  },
  "calls_left": 1000,
  "timestamp": 1487658324
}

Still need help? Contact Us Contact Us