Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

searchListMembers


The searchListMembers() searches across all member lists for records containing a specified value in a specified field. Only field names that have been set in a call to setIndexedListFields() can be used in a search.

Input

[vrtypens:searchListMembersArgs]

session_id [xsd:string] (required)
Your API session id.
field_name [xsd:string] (required)
The name of the field to search by. This should be a list field name.
Lists that don’t contain this field won’t be searched.
field_value [xsd:string] (required)
The value that’s desired in the result ListMembers. The call returns
only ListMembers whose value for the given field name matches this.
list_id [xsd:int]
If this is set, then the search will be limited to the specified list. Otherwise
the search is performed across all lists.
max_records [xsd:int]
Set this argument to limit the number of ListMembers returned

Output

[vrtypens:ArrayOfListMember]
An array of ListMembers that match the query arguments

Examples

Perl

$vrapi->searchListMembers( {
    session_id => $sid,
    field_name => 'Country',
    field_value => 'Mexico',
    max_records => 200
} );

PHP

$vrapi->searchListMembers( array(
    'session_id'  => $sid,
    'field_name'  => 'Country',
    'field_value' => 'Mexico',
    'max_records' => 200
) );

Ruby

vr.searchListMembers({
    'session_id'  => sid,
    'field_name'  => 'Country',
    'field_value' => 'Mexico',
    'max_records' => 200
})