Back to Documentation Overview

listMembers

public static listMembers(string apikey, string id, string status, integer start, integer limit)

Get all of the list members for a list that are of a particular status

Section:
List Related
Parameters:
apikey a valid API Key for your user account. Get by calling login()
id the list id to connect to. Get by calling lists()
status the status to get members for - one of(subscribed, unsubscribed, or cleaned), defaults to subscribed
start optional - for large data sets, the page number to start at - defaults to 1st page of data (page 0)
limit optional - for large data sets, the number of results to return - defaults to 100, upper limit set at 15000
Returns:
array   -  Array of list member structs (see Returned Fields for details)
Returned Fields:
string email Member email address
date timestamp timestamp of their associated status date ( subscribed, unsubscribed, or cleaned)

Examples (1)

download example code

[1] mcapi_listMembers.php

  1. <?php
  2. /**
  3. This Example shows how to pull the Members of a List using the MCAPI.php
  4. class and do some basic error checking.
  5. **/
  6. require_once 'inc/MCAPI.class.php';
  7. require_once 'inc/config.inc.php'; //contains apikey
  8.  
  9. $api = new MCAPI($apikey);
  10.  
  11. $retval = $api->listMembers($listId, 'subscribed', 0, 5000 );
  12.  
  13. if ($api->errorCode){
  14. echo "Unable to load listMembers()!";
  15. echo "\n\tCode=".$api->errorCode;
  16. echo "\n\tMsg=".$api->errorMessage."\n";
  17. echo "Members returned: ". sizeof($retval). "\n";
  18. } else {
  19. echo "Members returned: ". sizeof($retval). "\n";
  20. foreach($retval as $member){
  21. echo $member['email']." - ".$member['timestamp']."\n";
  22. }
  23. }
  24.  
  25. ?>
  26.  
Add New Note User Contributed Notes for listMembers
No notes, yet... Will you be the first??