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

JSON Request Example:    

  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Segments",
  "requestmethod": "GetSegmentSubscribers",
  "details": {
    "segmentid": ["{*segment_id*}", "{*segment_id*}"], /* at least one segment id required */
    "status": "{*status: any|active|inactive|bounced|unsubscribed*}",
    "include_membership": "{*include_membership_boolean*}"

"json_request" element    

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

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