Returns the master unsubscribed subscribers for the user account. The call also allows the user to determine how many records will be returned by individual call and what record number to use to start the initial call and subsequent calls. In this way a user could set up a script to run a sequence of calls returning the first 100 contacts, the second call would return the next 100 and so forth. User may also select one of several fields by which to sort the return data.   

JSON Request Example: 

  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Subscribers",
  "requestmethod": "GetMasterUnsubscribes",
  "details": {
    "pagination": {
      "limit": "{*max_records*}",
      "next": "{*start_at_record_number*}"
    "sort": {
      "field": "{*sort_field*}",
      "direction": "{*sort_direction: asc|desc*}"


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 pagination is to be used, the <pagination> and element and its sub-elements should be deleted.


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

Successful Response:

"response" element

Field NameDescription
statusWill return SUCCESS if contacts were successfully returned. 
dataRecord count for returned subscribers
Page count
<item> element for each returned subscriber:
  • ID
  • Email address
  • Unsubscribe date
  • IP address
  • Account owner ID
<field> value used for sort
Direction of sort
Page count

Unsuccessful Response:

"response" element

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