Get All Subscribers

Retrieve paginated subscribers from a specific segment within a list. This endpoint is helpful for filtering contacts based on segment rules and viewing their status and metadata.

👥 Get All Subscribers (From List Segment)

Retrieve all subscribers belonging to a specific segment of a list. This helps you filter and access targeted contacts based on segment criteria.

🔹 HTTP Request

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

🔸 URL Segments

Segment	Required	Description
LIST-UNIQUE-ID	Yes	Unique identifier of the list.
SEGMENT-UNIQUE-ID	Yes	Unique identifier of the segment in the list.

🔸 Query Parameters

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

🔐 Authorization Header

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

---

💻 PHP Example

// GET ALL SUBSCRIBERS OF A LIST SEGMENT
$response = $endpoint->getSubscribers('LIST-UNIQUE-ID', 'SEGMENT-UNIQUE-ID', $pageNumber = 1, $perPage = 10);

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

---

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "count": "13",
    "total_pages": 2,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "records": [
      {
        "subscriber_uid": "ll381bxshm01e",
        "EMAIL": "[email protected]",
        "FNAME": "",
        "LNAME": "",
        "status": "unsubscribed",
        "source": "import",
        "ip_address": "",
        "date_added": "2021-02-20 17:26:18"
      },
      {
        "subscriber_uid": "vo155s4b0d0ad",
        "EMAIL": "[email protected]",
        "FNAME": "",
        "LNAME": "",
        "status": "confirmed",
        "source": "import",
        "ip_address": "",
        "date_added": "2021-02-20 17:26:14"
      }
    ]
  }
}

---