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

System runs asynchronously in the background to allow retrieving payloads for larger tags. User has option of receiving notification of call completion and a link to download the JSON file either via email or by webhook.  

JSON Request Example:  


"json_request"  element

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

"details" element


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

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

"customfields" element

customfields (optional)User may retrieve a contact's custom field values by specifying the name(s) of the custom fields to be be returned, or by entering "all" as the parameter value.

"notify" element

type (required)Method by which user wishes to be notified that the call has completed processing and what the link to the JSON file is: either "email" or "webhook"
value (required)If user selects notification via email, they must provide a valid email address which will receive the email notification. If user selects notification via webhook, they must provide a valid webhook URL to receive the payload, including the link to the JSON file. 

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:

(Where user has selected "email-address" as notification method and provided an email address):

(Where user has selected "webhook-url" as notification method and provided a webhook URL):

Unsuccessful Response:

"response" element

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