Search for subscribers in a mailing list and retrieve their email addresses.
JSON Request Example:
"json_request" 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 (optional) | Status of contacts to be searched for. Value can be any, active, inactive, bounced or unsubscribed. Default is any. |
"include_membership" element
include_membership (optional) | 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 sub-element count (the number of subscribers being returned); and subscribers, a list of email addresses and the respective data for each subscriber. |
Example of returned data:
Unsuccessful Response:
"response" element
Field Name | Description |
status | Will return ERROR if unsuccessful |
errormessage | Text explaining why request failed |