Get All Subscribers
Retrieve all subscribers associated with a specific list. This endpoint supports pagination and returns subscriber details such as email, status, and source.
📋 Get All Subscribers (From List)
Fetch all subscribers from a specific list with optional pagination parameters.
🔹 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.
🔐 Authorization Header
X-API-KEY: your-api-key-here
💻 PHP Example
// GET ALL ITEMS
$response = $endpoint->getSubscribers('LIST-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": "ab123xyzlmn90",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "unsubscribed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:20:10"
},
{
"subscriber_uid": "cd456uvtpqr78",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "unsubscribed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:21:03"
},
{
"subscriber_uid": "ef789lkjghi45",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "unsubscribed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:21:22"
},
{
"subscriber_uid": "gh012mnopqw34",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "confirmed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:22:01"
},
{
"subscriber_uid": "ij345rstabc67",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "confirmed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:22:15"
},
{
"subscriber_uid": "kl678uvwxzy23",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "confirmed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:23:07"
},
{
"subscriber_uid": "mn901defghij1",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "confirmed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:24:12"
},
{
"subscriber_uid": "op234jklmnop9",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "confirmed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:25:05"
},
{
"subscriber_uid": "qr567abcduvw3",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "confirmed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:26:11"
},
{
"subscriber_uid": "st890efghijk2",
"EMAIL": "[email protected]",
"FNAME": "",
"LNAME": "",
"status": "confirmed",
"source": "import",
"ip_address": "",
"date_added": "2024-11-15 08:27:14"
}
]
}
}
Last updated