Retrieve the specified subscriber by subscriber ID who may be on one or more lists, including their respective custom field data.

JSON request example:

  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Subscribers",
  "requestmethod": "GetSubscribersById",
  "details": {
    "list": "{*list_id*}", /* required */
    "subscriberid": ["{*subscriber_id*}", "{*subscriber_id*}"], /* required: at least one */
    "customfields": ["{*customfield_name*}", "{*customfield_name*}", "all"],
    "sort": {
      "field": "{*sort_field*}",
      "direction": "{*sort_direction: asc|desc|orig*}"
    "include_membership": "{*include_membership_boolean*}"

"json_request" element

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

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 NameDescription
(At least one required)
ID of list(s) to be searched for the specified contact.
(At least one required)
Subscriber ID(s) of contact(s) to search for.
customfieldComma-separated list of custom field IDs. Or user may use the default "all" value provided.


"pagination" OPTIONAL

Field NameDescription
limitEnter an integer to set the numerical limit for number of master-unsubscribe subscriber records that will be returned from a single call. 
nextStarting subscriber record number for a given call. If element is deleted, default is 0 (first record).



Field NameDescription
fieldID of custom field to be added. If <sort> tag deleted, system will sort by subscribers' email address. 
directionSort order of either ascending or descending. 


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

Successful Response:

"response" element

Field NameDescription
statusWill return SUCCESS if subscriber and list successfully found


"item" element

System will return a full dataset of subscriber attribute values on the found subscriber, 

Unsuccessful Response:

"response" element

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