Get Unsubscribed Subscribers

Retrieve all subscribers with the status unsubscribed from a specific list. Useful for managing opt-outs and analyzing churn.

📭 Get Unsubscribed Subscribers

Fetch unsubscribed contacts from a list using list UID and pagination options.

---

🔹 HTTP Request

GET API-URL/lists/LIST-UNIQUE-ID/subscribers

---

🔸 URL Segments

Segment	Required	Description
LIST-UNIQUE-ID	Yes	Unique identifier of the subscriber list.

---

🔎 Query Parameters

Parameter	Default	Description
page	1	Page number to retrieve.
per_page	10	Number of subscribers per page.
status	unsubscribed	Filters only unsubscribed subscribers.

---

🔐 Authorization Header

X-API-KEY: your-api-key-here

---

💻 PHP Example

// GET ALL ITEMS
$response = $endpoint->getUnsubscribedSubscribers('LIST-UNIQUE-ID', $pageNumber = 1, $perPage = 10);

// DISPLAY RESPONSE
echo '<pre>';
print_r($response->body);
echo '</pre>';

---

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "count": "3",
    "total_pages": 1,
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "records": [
      {
        "subscriber_uid": "ty389plsknq01",
        "EMAIL": "[e-mail]",
        "FNAME": "",
        "LNAME": "",
        "source": "import",
        "status": "unsubscribed",
        "ip_address": "",
        "date_added": "2025-04-17 11:03:22"
      },
      {
        "subscriber_uid": "uk472mqwzle19",
        "EMAIL": "[e-mail]",
        "FNAME": "",
        "LNAME": "",
        "source": "import",
        "status": "unsubscribed",
        "ip_address": "",
        "date_added": "2025-04-17 11:03:18"
      },
      {
        "subscriber_uid": "ze604ndxwcu87",
        "EMAIL": "[e-mail]",
        "FNAME": "",
        "LNAME": "",
        "source": "import",
        "status": "unsubscribed",
        "ip_address": "",
        "date_added": "2025-04-17 11:03:14"
      }
    ]
  }
}