Retrieve contacts within or or more tags with option to exclude contacts belonging to a subset of to-be-excluded tags (Called "lists" within the GUI application).


JSON Request Example:



{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Tags",
  "requestmethod": "GetTagSubscribers",
  "details": {
    "tag": ["{*include_tag_id*}", "{*include_tag_id*}"], /* required */
    "extag": ["{*exclude_tag_id*}", "{*exclude_tag_id*}"],
    "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
requesttypeTags
requestmethodGetTagSubscribers


Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. For example, If no tag is to be excluded, remove the <extag>{*exclude_tag_id*}</extag> elements. In addition, if only one tag is being searched, remove all unused <tag></tag> elements.


"details" element

"tag"


Field NameDescription
tag
(Required)
ID of tag to be searched. At least one required.  
extag
ID of optional tag who contacts should be excluded from the search.
status
Select from the options provided to search for contacts with that status.


"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 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