API Documentation

Search Methods » SearchTitleSubscribers

This method returns a search result of all subscribers in a specified Title matched against a supplied query

Required paramaters: standard, TitleId, Query

Optional paramaters: standard, Limit, Page, SortBy, SortDirection

For master account Key/Signature pair, the paramater UserId is also required.

Example Response (XML)

<Subscriber>
	<subscriber_id>203</subscriber_id>
	<username>johndoe1</username>
	<first_name>John</first_name>
	<last_name>Doe</last_name>
	<email><johndoe65@hotmail.com</email>
	<email_verified>0</email_verified>
	<verify_email_sent>3</verify_email_sent>
	<address>123 Lane Blvd.</address>
	<address2>Unit 4</address2>
	<city>Springfield</city>
	<state>OH</state>
	<country>US</country>
	<zip>19543</zip>
	<phone>555-123-4543</phone>
	<opt_in>1</optin>
	<current_paid_subscriber>0</current_paid_subscriber>
	<user_defined_1>2011-10-01</user_defined_1>
	<user_defined_2/>
	<user_defined_3/>
	<modified>2010-04-08 16:06:24</modified>
	<created>2010-03-19 16:43:32</created>
	<last_login>2010-09-12 12:41:02/last_login>
</Subscriber>
<Subscriber>
	...
</Subscriber>
<Pagination>
	<TotalResults>54</TotalResults>
	<TotalPages>6</TotalPages>
	<Page>1</Page>
</Pagination>

Sorting Options

SortBy possible values:

subscriber_id
username
first_name
last_name
email
email_verified
verify_email_sent
address
address2
city
state
country
zip
phone
opt_in
current_paid_subscriber
user_defined_1
user_defined_2
user_defined_3
modified
created
last_login

SortDirection possible values:

ASC
DESC