listMemberInfo – v1.3

 listMemberInfo(string apikey, string id, array email_address)

Get all the information for particular members of a list

Section
List Related

Parameters
apikey	a valid API Key for your user account. Get by visiting your API dashboard
id	the list id to connect to. Get by calling lists()
email_address	an array of up to 50 email addresses to get information for OR the "id"(s) for the member returned from listMembers, Webhooks, and Campaigns. For backwards compatibility, if a string is passed, it will be treated as an array with a single element (will not work with XML-RPC).

Returns

array

array of list members with their info in an array (see Returned Fields for details) int success the number of subscribers successfully found on the list int errors the number of subscribers who were not found on the list array data an array of arrays where each one has member info: string id The unique id for this email address on an account string email The email address associated with this record string email_type The type of emails this customer asked to get: html, text, or mobile array merges An associative array of all the merge tags and the data for those tags for this email address. Note: Interest Groups are returned as comma delimited strings - if a group name contains a comma, it will be escaped with a backslash. ie, "," => "\,". Groupings will be returned with their "id" and "name" as well as a "groups" field formatted just like Interest Groups string status The subscription status for this email address, either pending, subscribed, unsubscribed, or cleaned string ip_opt IP Address this address opted in from. string ip_signup IP Address this address signed up from. int member_rating the rating of the subscriber. This will be 1 - 5 as described here string campaign_id If the user is unsubscribed and they unsubscribed from a specific campaign, that campaign_id will be listed, otherwise this is not returned. array lists An associative array of the other lists this member belongs to - the key is the list id and the value is their status in that list. date timestamp The time this email address was added to the list date info_changed The last time this record was changed. If the record is old enough, this may be blank. int web_id The Member id used in our web app, allows you to create a link directly to it array geo the geographic information if we have it. including: string latitude the latitude string longitude the longitude string gmtoff GMT offset string dstoff GMT offset during daylight savings (if DST not observered, will be same as gmtoff string timezone the timezone we've place them in string cc 2 digit ISO-3166 country code string region generally state, province, or similar array clients the client we've tracked the address as using with two keys: string name the common name of the client string icon_url a url representing a path to an icon representing this client array static_segments static segments the member is a part of including: int id the segment id string name the name given to the segment string added the date the member was added

Examples (2)

download example code

[1] mcapi_listMemberInfo.php

<?php
/**
This Example shows how to pull the Info for a Member of a List using the MCAPI.php 
class and do some basic error checking.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$retval = $api->listMemberInfo( $listId, array($my_email, $boss_man_email) );
 
if ($api->errorCode){
	echo "Unable to load listMemberInfo()!\n";
	echo "\tCode=".$api->errorCode."\n";
	echo "\tMsg=".$api->errorMessage."\n";
} else {
	echo "Success:".$retval['success']."\n";
	echo "Errors:".sizeof($retval['error'])."\n";
    //below is stupid code specific to what is returned
    //Don't actually do something like this.
    $i = 0;
    foreach($retval['data'] as $k=>$v){
        echo 'Member #'.(++$i)."\n";
        if (is_array($v)){
            //handle the merges
            foreach($v as $l=>$w){
                if (is_array($w)){
                    echo "\t$l:\n";
                    foreach($w as $m=>$x){
                        echo "\t\t$m = $x\n";
                    }
                } else {
                    echo "\t$l = $w\n";
                }
            }
        } else {
            echo "$k = $v\n";
        }
    }
}
 
?>
 

[2] xml-rpc_listMemberInfo.php

<?php
/**
This Example shows how to retrieve a list subscriber's information using XML-RPC
Note that we are using the PEAR XML-RPC client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
	$result = $client->listMemberInfo($apikey, $listId, $my_email);
	echo "SUCCESS! \n";
	echo "Info for: ".$result['email']."\n";
	echo " Email Type: ".$result['email_type']."\n";
	echo " Status: ".$result['status']."\n";
	echo " Timestamp: ".$result['timestamp']."\n";
	echo " Merges:\n";
	foreach($result['merges'] as $k=>$v){
	    echo "\t$k = $v\n";
	}
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo 'code: '.$e->getFaultCode()."\n";
	echo 'msg : '.$e->getFaultString()."\n";
}
 
?>