Search for subscribers in one or more mailing list and retrieve their respective information including subscriber ID, email address, whether confirmed or not and other relevant information.
XML Request Example:
<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
<username>JohnDoe</username>
<usertoken>abc123abc123abc123abc123</usertoken>
<requesttype>Lists</requesttype>
<requestmethod>GetListSubscribers</requestmethod>
<details>
<list>{*list_id*}</list> <!-- required -->
<list>{*list_id*}</list>
<status>{*status: any|active|inactive|bounced|unsubscribed*}</status>
<include_membership>{*include_membership_boolean*}</include_membership>
</details>
</xmlrequest>
<xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Lists |
| requestmethod | GetListSubscribers |
<details>
| Field Name | Description |
| List | ID of list to be searched. Can add multiple <list> tags to search more than one list. |
| status | Status of contacts to be searched for. Value can be any, active, inactive, bounced or unsubscribed. Default is any. |
"include_membership" element
| include_membership | PieSync requirement: Setting this element's value to true, 1 or yes results in the API call adding a list of all tags that a subscriber is in as part of the returned information for that subscriber. |
Successful Response:
<response> element
| Field Name | Description |
| status | Will return SUCCESS if user was successfully added |
| data | Includes relevant data per contact |
Example of returned data:
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return ERROR if unsuccessful |
| errormessage | Text explaining why request failed |