Search for subscribers in a segment and retrieve their email addresses.

XML Request Example:    

<?xml version="1.0" encoding="UTF-8"?>
    <segmentid>{*segment_id*}</segmentid> <!-- 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
requesttypeName of API set to be used
requestmethodFunction being called

Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. For example, if only one segmentid is being searched, remove all unused <segmentid></segmentid> elements.

<details> element


Field NameDescription
ID of segment to be searched. At least one required.  
Select from the options provided to search for contacts with that status.
Will default to "all".

"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 contacts were successfully found.
dataContact count, status selected, subscriber details.

Unsuccessful Response:

<response> element

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