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


JSON Request Example:     

{
  "username": "DRB-Test",
  "usertoken": "a1de7f1e68e24201ad22a0cb166eee90c969237e",
  "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
requesttypeName of API set to be used
requestmethodFunction being called


"details" 


Field NameDescription
list
(Required)
ID of contact list to be searched. Can enter more than one ID but at least one must be entered.
status"any" is the default but user may specify any valid value.


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.



Unsuccessful Response:


"response" element


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