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"?>
    <list>{*list_id*}</list> <!-- required -->
    <status>{*status: any|active|inactive|bounced|unsubscribed*}</status>


<xmlrequest> element

Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account


Field NameDescription
ListID of list to be searched.
Can add multiple <list> tags to search more than one list.
statusStatus of contacts to be searched for. Value can be any, active, inactive, bounced or unsubscribed. Default is any.

"include_membership" element

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 NameDescription
statusWill return SUCCESS if user was successfully added
dataIncludes relevant data per contact

Example of returned data:

Unsuccessful Response:

<response> element

Field NameDescription
statusWill return ERROR if unsuccessful
errormessageText explaining why request failed