Search for subscribers in a mailing list and retrieve their email addresses.


JSON Request Example:     

{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Lists",
  "requestmethod": "GetListSubscribers",
  "details": {
    "list": ["{*list_id*}", "{*list_id*}"], /* at least one list_id required */
    "status": "{*status: any|active|inactive|bounced|unsubscribed*}",
    "include_membership": "{*include_membership_boolean*}"
  }
} 
Null

  

"json_request"  element


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


"details" 


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


include_membership
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 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 NameDescription
statusWill return ERROR if unsuccessful
errormessageText explaining why request failed