function MCAPI::listMembers in Mailchimp 6.2

Same name and namespace in other branches

1. 5.2 MCAPI.class.php \MCAPI::listMembers()
2. 5 MCAPI.class.php \MCAPI::listMembers()
3. 6 MCAPI.class.php \MCAPI::listMembers()
4. 7 MCAPI.class.php \MCAPI::listMembers()

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

Related

@example mcapi_listMembers.php

@returnf string email Member email address @returnf date timestamp timestamp of their associated status date (subscribed, unsubscribed, cleaned, or updated) in GMT

Parameters

string $id the list id to connect to. Get by calling lists():

string $status the status to get members for - one of(subscribed, unsubscribed, <a target="_blank" href="http://eepurl.com/dwk1">cleaned</a>, updated), defaults to subscribed:

string $since optional pull all members whose status (subscribed/unsubscribed/cleaned) has changed or whose profile (updated) has changed since this date/time (in GMT) - format is YYYY-MM-DD HH:mm:ss (24hr):

integer $start optional for large data sets, the page number to start at - defaults to 1st page of data (page 0):

integer $limit optional for large data sets, the number of results to return - defaults to 100, upper limit set at 15000:

Return value

array Array of list member structs (see Returned Fields for details)

File

./MCAPI.class.php, line 1599

Class

MCAPI

Code

function listMembers($id, $status = 'subscribed', $since = NULL, $start = 0, $limit = 100) {
  $params = array();
  $params["id"] = $id;
  $params["status"] = $status;
  $params["since"] = $since;
  $params["start"] = $start;
  $params["limit"] = $limit;
  return $this
    ->callServer("listMembers", $params);
}