Retrieve the specified subscriber who may be on one or more lists, including their respective custom field data.
Note: A truncated version of this API call can also be found under the requesttype of "Lists".
XML request example:
<?xml version="1.0" encoding="UTF-8"?>
<xmlrequest>
<username>JohnDoe</username>
<usertoken>abc123abc123abc123abc123</usertoken>
<requesttype>Subscribers</requesttype>
<requestmethod>GetSubscribers</requestmethod>
<details>
<searchinfo>
<list>{*list_id*}</list> <!-- required: at least one -->
<list>{*list_id*}</list>
<email>{*email_address*}</email>
</searchinfo>
<customfields>{*customfield_name*}</customfields>
<customfields>{*customfield_name*}</customfields>
<customfields>all</customfields>
<pagination>
<limit>{*max_records*}</limit>
<next>{*start_at_record_number*}</next>
</pagination>
<sort>
<field>{*sort_field*}</field>
<direction>{*sort_direction: asc|desc*}</direction>
</sort>
<include_membership>{*include_membership_boolean*}</include_membership>
</details>
<version>4.0</version>
</xmlrequest><xmlrequest> element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Subscribers |
| requestmethod | GetSubscribers |
Please note: ALL OPTIONAL tags that are not used should be deleted from submitted call. For example, if no <customfield> value is inserted, the <customfield> tags should be deleted.
<details> element
| Field Name | Description |
| list (At least one required) | ID of list(s) to be searched for the specified contact. |
| email | Email address of contact to search for. |
| customfield | Comma-separated list of custom field IDs. Or user may use the default "all" value provided. |
<details>
<pagination> OPTIONAL
| Field Name | Description |
| limit | Enter an integer to set the numerical limit for number of master-unsubscribe subscriber records that will be returned from a single call. |
| next | Starting subscriber record number for a given call. If element is deleted, default is 0 (first record). |
<details>
<sort> OPTIONAL
| Field Name | Description |
| field | ID of custom field to be added. If <sort> tag deleted, system will sort by subscribers' email address. |
| direction | Sort order of either ascending or descending. |
<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 Name | Description |
| status | Will return SUCCESS if subscriber and list successfully found |
<data>
<item> element
System will return a full dateset of subscriber attribute values on the found subscriber,
Unsuccessful Response:
<response> element
| Field Name | Description |
| status | Will return FAILED if unsuccessful |
| errormessage | Text explaining why request failed |