Search Subscribers by Status

Search subscribers by their status (e.g., confirmed, unsubscribed, blacklisted) within a specific list. This is useful for filtering active or inactive contacts.

📂 Search Subscribers by Status

Retrieve a list of subscribers from a given list filtered by their current status.

---

🔹 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	Required / Default	Description
status	Yes	Status of the subscribers to filter.
page	1	Page number to retrieve.
per_page	10	Items per page to retrieve.

---

🔐 Authorization Header

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

---

💻 PHP Example

// SEARCH BY STATUS
$response = $endpoint->searchByStatus('LIST-UNIQUE-ID', 'confirmed', $pageNumber = 1, $perPage = 10);

// DISPLAY RESPONSE
echo '<hr /><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": "gh238lmnqrp01",
        "EMAIL": "[email protected]",
        "FNAME": "",
        "LNAME": "",
        "source": "import",
        "status": "confirmed",
        "ip_address": "",
        "date_added": "2025-04-12 09:15:34"
      },
      {
        "subscriber_uid": "za904wxyekc72",
        "EMAIL": "[email protected]",
        "FNAME": "",
        "LNAME": "",
        "source": "import",
        "status": "confirmed",
        "ip_address": "",
        "date_added": "2025-04-12 09:15:20"
      },
      {
        "subscriber_uid": "lp563vutneh43",
        "EMAIL": "[email protected]",
        "FNAME": "",
        "LNAME": "",
        "source": "import",
        "status": "confirmed",
        "ip_address": "",
        "date_added": "2025-04-12 09:14:58"
      }
    ]
  }
}