Get Subscribers (list - GetListSubscribers)
Modified on: Fri, Sep 1, 2023 at 6:37 PM
Search for subscribers in a mailing list and retrieve their email addresses.
JSON Request Example:
|username||Username used to login to Pinpointe|
|usertoken||Unique token assigned to Pinpointe account|
|List||ID of list to be searched.|
Can add multiple <list> tags to search more than one list.
|Status of contacts to be searched for. Value can be any, active, inactive, bounced or unsubscribed. Default is any.|
|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.|
|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:
|status||Will return ERROR if unsuccessful|
|errormessage||Text explaining why request failed|
Did you find it helpful?
Can you please tell us how we can improve this article?