Getting all subscribers of a list including all custom fields (apiGetSubscriberDetails)
With this option, you retrieve all subscribers to a list. In contrast to apiGetSubscriber, the subscribers are returned together with personalization fields. The amount of data is larger, and wait time is therefore longer.
Request
| Name | Type | Example | Required | Comment |
|---|---|---|---|---|
| listID | Integer | 123456789 | apiGetList() delivers all possible List IDs. | |
| start | Integer | 0 | ||
| count | Integer | 100 | limited to 100 |
Response
[0] => stdClass Object
(
[subscriberID] => 1200863
[subscriberEmail] => max.mustermann@test.de
[customFields] => Array
(
[0] => stdClass Object
(
[customFieldID] => 123456
[customFieldValue] => Max
)
[1] => stdClass Object
(
[customFieldID] => 123457
[customFieldValue] => Mustermann
)
[2] => stdClass Object
(
[customFieldID] => 123458
[customFieldValue] => Herr
)
[3] => stdClass Object
(
[customFieldID] => 123459
[customFieldValue] => Dr.
)
)
[subsriberHistory] => Array
(
[0] => stdClass Object
(
[newsletterID] => 91
[newsletterName] => Newsletter1
[sendAt] => 2015-06-30 10:56:10
)
[1] => Array
(
[newsletterID] => 92
[newsletterName] => Newsletter2
[sendAt] => 2015-10-30 10:56:27
)
[2] => Array
(
[newsletterID] => 93
[newsletterName] => Newsletter3
[sendAt] => 2016-01-30 11:02:36
)
[3] => Array
(
[newsletterID] => 94
[newsletterName] => Newsletter4
[sendAt] => 2016-04-03 11:03:32
)
)
)
[...]
Error Response
| Code | Interpretation |
|---|---|
| 204 | No subscribers were found in this list. Please check if a valid List ID was passed. |
| 404 | No valid List ID was passed. |
PHP5 Example
try{
$request = array(
'start'=> 0,
'count'=> 100,
'listID'=> 123456,
);
$response=$client->apiGetSubscriberDetails($request);
}
catch (SoapFault $exception) {
echo ($exception->getMessage());
}