MPZ API > List Subscribers

Use the API to retreive subscribers from a group.

Request

Submit an XML Request with the following details:
Post URL: https://mpzmail.com/api/v3.0/subscribers/listSubscribers/
Fields to Post
apiKey String REQUIRED The APIKey of the requesting user.
groupID Int REQUIRED The ID of the group you would like to request subscribers from.
noOfSubscribers Int Optional The number of subscribers to return. Leave as 0 or blank for all.
sortField String Optional The field to sort by. Options are: subscriberID (Default), firstName, lastName, companyName
sortOrder String Optional The direction to sort by. Options are: asc, desc.
emailAddress String Optional Search for a part of, or a whole email address

Response

Data Sent Back
error Int Indicates wether an error has occured. 0 for no error. 1 for error.
status String If there's been an error, a text description of the error that occured will be here.
subscriberCnt Int The number of subscribers returned.
subscribers    
---> subscriber    
--------> subscriberID Int The ID of the subscriber.
--------> firstName String The first name of the subscriber.
--------> lastName String The last name of the subscriber.
--------> companyName String The company name of the subscriber.
--------> email String The email address of the subscriber.
--------> dateAdded Date Time The date the subscriber was added.
--------> customField1 String Custom Field
--------> customField2 String Custom Field
--------> customField3 String Custom Field
--------> customField4 String Custom Field
--------> customField5 String Custom Field
--------> customField6 String Custom Field
--------> customField7 String Custom Field
--------> customField8 String Custom Field
--------> customField9 String Custom Field
--------> customField10 String Custom Field

Sample request XML

<xml>
     <apiKey>44-121312131223</apiKey>
     <groupID>123</groupID>
</xml>

Sample response XML

<xml>
     <error>0</error>
     <status>success</status>
     <subscriberCnt>2</subscriberCnt>
     <subscribers>
          <subscriber>
               <subscriberID>1311</subscriberID>
               <firstName>Test</firstName>
               <lastName>User</lastName>
               <companyName>Test Co</companyName>
               <email>test@test.com</email>
               <dateAdded>2014-01-01 11:37</dateAdded>
          </subscriber>
          <subscriber>
               <subscriberID>1312</subscriberID>
               <firstName>Test2</firstName>
               <lastName>User2</lastName>
               <companyName>Test Co2</companyName>
               <email>test@test2.com</email>
               <dateAdded>2014-03-05 12:25</dateAdded>
          </subscriber>
     </subscribers>
</xml>

Comments