Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

getListMembers


The getListMembers() method retrieves a fixed number of members from a specified list. Ordering and offset information can be used to created “windowed” views of list member data. If requesting a large number of list members, use downloadList instead.

Input

[vrtypens:getListMembersArgs]

session_id [xsd:string] (required)
Your API session id.
list_id [xsd:int] (required)
The id of the list whose members are being retrieved.
max_records [xsd:int] (required)
The maximum number of records to return.
offset [xsd:int]
Only records on or beyond this index are included in the result.
order_by_fields [vrtypens:ArrayOfOrderByField]
An array of fields and directions that specify an ordering for the returned campaigns.
first_order_by_field_start_at [xsd:string]
When order_by_fields is provided, this specifies a value for the first field that output should start at.

Output

[vrtypens:ArrayOfListMember]
The output is an array of members that are in the specified list.

Examples

PHP

$vr->getListMembers( array(
	'session_id'=> $sid,
	'list_id'   => $lid,
	'max_records' => 10,
) );

Ruby

vr.getListMembers({
	'session_id'=> sid,
	'list_id'   => lid,
	'max_records' => 10,
})

Java

GetListMembersArgs getListMembersArgs = new GetListMembersArgs();
	getListMembersArgs.setSession_id(sessionID);
	getListMembersArgs.setList_id(listID);
	getListMembersArgs.setMax_records(10);

ListMember[] listMembers = vr.getListMembers(getListMembersArgs);

C#/.NET

getListMembersArgs gLMA = new getListMembersArgs();
	gLMA.session_id = sessionId;
	gLMA.list_id = listID;
	gLMA.max_records = 10;

try
{
	Array listMembers = objVR.getListMembers(gLMA);
}
catch (Exception e)
{
	System.Console.WriteLine(e.Message);
}

Perl

$vrapi->getListMembers( {
	session_id => $sid,
	list_id => $lid,
	max_records => 10,
} );