/api/member/search

get

Search for members

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

fieldsstringOptional

downloadstringOptional

output_formatstringOptionalDefault: --broken--

start_timestringOptional

end_timestringOptional

banned_historystringOptional

whitelist_historystringOptional

denied_loginlogsstringOptional

biller_expire_startstringOptional

biller_expire_start_comparestringOptionalDefault: =

biller_expire_endstringOptional

biller_expire_end_comparestringOptionalDefault: =

biller_expire_not_setstringOptional

nats_expire_startstringOptional

natsr_expire_start_comparestringOptionalDefault: =

nats_expire_endstringOptional

nats_expire_end_comparestringOptionalDefault: =

nats_expire_not_setstringOptional

expires_startstringOptional

expires_start_comparestringOptionalDefault: =

expires_endstringOptional

expires_end_comparestringOptionalDefault: =

expires_not_setstringOptional

last_login_startstringOptional

last_login_start_comparestringOptionalDefault: =

last_login_endstringOptional

last_login_end_comparestringOptionalDefault: =

last_login_not_setstringOptional

member_expired_startstringOptional

member_expired_start_comparestringOptionalDefault: =

member_expired_endstringOptional

member_expired_end_comparestringOptionalDefault: =

member_sub_expired_startstringOptional

member_sub_expired_start_comparestringOptionalDefault: =

member_sub_expired_endstringOptional

member_sub_expired_end_comparestringOptionalDefault: =

no_like_searchesstringOptional

countintegerOptionalDefault: 25

startintegerOptionalDefault: 0

orderbystringOptional

as_arraystringOptional

widgetstringOptionalDefault: 0

additional_flagsstringOptional

address1stringOptional

address1_comparestringOptionalDefault: =

address2stringOptional

address2_comparestringOptionalDefault: =

affiliatestringOptional

billeridstringOptional

billerid_comparestringOptionalDefault: =

campaignidstringOptional

campaignid_comparestringOptionalDefault: =

cascadeidstringOptional

cascadeid_comparestringOptionalDefault: =

citystringOptional

city_comparestringOptionalDefault: =

coupon_codestringOptional

coupon_code_comparestringOptionalDefault: =

couponidstringOptional

couponid_comparestringOptionalDefault: =

coupon_revision_idstringOptional

coupon_usedstringOptional

countrystringOptional

country_comparestringOptionalDefault: =

countryidstringOptional

custom1stringOptional

custom1_comparestringOptionalDefault: =

custom2stringOptional

custom2_comparestringOptionalDefault: =

custom3stringOptional

custom3_comparestringOptionalDefault: =

custom4stringOptional

custom4_comparestringOptionalDefault: =

custom5stringOptional

custom5_comparestringOptionalDefault: =

custom6stringOptional

custom6_comparestringOptionalDefault: =

custom7stringOptional

custom7_comparestringOptionalDefault: =

custom8stringOptional

custom8_comparestringOptionalDefault: =

custom9stringOptional

custom9_comparestringOptionalDefault: =

custom10stringOptional

custom10_comparestringOptionalDefault: =

emailstringOptional

email_comparestringOptionalDefault: =

firstnamestringOptional

firstname_comparestringOptionalDefault: =

markedstringOptional

marked_comparestringOptionalDefault: =

ipstringOptional

ip_comparestringOptionalDefault: =

lastnamestringOptional

lastname_comparestringOptionalDefault: =

loginidstringOptional

loginid_comparestringOptionalDefault: =

loginipstringOptional

manualstringOptional

mailokstringOptional

memberidstringOptional

memberid_comparestringOptionalDefault: =

natscodestringOptional

natscode_comparestringOptionalDefault: =

nats_transaction_idstringOptional

not_logged_instringOptional

optionidstringOptional

optionid_comparestringOptionalDefault: =

passthrough1stringOptional

passthrough1_comparestringOptionalDefault: =

passthrough2stringOptional

passthrough2_comparestringOptionalDefault: =

passthrough3stringOptional

passthrough3_comparestringOptionalDefault: =

passthrough4stringOptional

passthrough4_comparestringOptionalDefault: =

passthrough5stringOptional

passthrough5_comparestringOptionalDefault: =

passwordstringOptional

periodintegerOptional

programidstringOptional

programid_comparestringOptionalDefault: =

siteidstringOptional

siteid_comparestringOptionalDefault: =

siteidsstringOptional

subscriptionstringOptional

statestringOptional

state_comparestringOptionalDefault: =

statidstringOptional

statusstringOptional

status_comparestringOptionalDefault: =

activestringOptional

active_comparestringOptionalDefault: =

subid1stringOptional

subid2stringOptional

subscription_comparestringOptionalDefault: =

text_searchstringOptional

touridstringOptional

tourid_comparestringOptionalDefault: =

trans_type_idstringOptional

biller_transidstringOptional

biller_transid_comparestringOptionalDefault: =

usernamestringOptional

username_comparestringOptionalDefault: =

zipstringOptional

zip_comparestringOptionalDefault: =

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

get

/api/member/search

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'username' => 'test username',
		'status' => 1,
		'firstname' => 'testFirstname'
	);

$request = array(
	'method' => 'GET',
	'path' => 'member/search',
	'data' => $data
);

/*code below is the same for (almost) every API call */

$curl = curl_init();

$url = $url.'/api/'.$request['path'];

$query = http_build_query($request['data']);

if($request['method'] == 'GET'){
	//add query string parameters to the end of the url
	$url = $url.'?'.$query;
}else{
	//send parameters as POST fields
	curl_setopt($curl, CURLOPT_POST, 1);
	curl_setopt($curl, CURLOPT_POSTFIELDS, $query);

	if($request['method'] != 'POST'){
		$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
	}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);


$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

200

success

{
  "3": {
    "memberid": "3",
    "identid": "4",
    "loginid": "0",
    "networkid": "0",
    "refurl_lookup_id": "2",
    "landing_page_lookup_id": "0",
    "status": "1",
    "trial": "0",
    "joined": "1565382563",
    "expired": "0",
    "last_login": "1565382564",
    "stamp": "1565382564",
    "siteid": "1",
    "username": "test username",
    "password": "testPassword",
    "cryptpass": "d3695SDTr1h2k",
    "ip": "",
    "email": "[e-mail]",
    "session": "4184eb9f9064c7b773c8dfd159505af4",
    "mailok": "1",
    "flat_price": "0",
    "first_login": "1565382564",
    "third_party_partner_id": "0",
    "cascadeid": "0",
    "cascade_item_id": "0",
    "token": "0",
    "original_username": "test username",
    "renamed": "0",
    "marked": "0",
    "token_hash": "f561384f9bf88197514d49fc321d5f85",
    "max_password_display_time": "0",
    "locked": "0",
    "firstname": "testFirstname",
    "lastname": "testLastname",
    "address1": "123 address street",
    "address2": "",
    "zip": "12345",
    "city": "testCity",
    "country": "",
    "state": "NJ",
    "shipping_firstname": "",
    "shipping_lastname": "",
    "shipping_address1": "",
    "shipping_address2": "",
    "shipping_zip": "",
    "shipping_city": "",
    "shipping_country": "",
    "shipping_state": "",
    "phone": "",
    "xsell_success": "0",
    "xsell_message": "",
    "custom1": "",
    "custom2": "",
    "custom3": "",
    "custom4": "",
    "custom5": "",
    "last_modified": "0",
    "custom6": "",
    "custom7": "",
    "custom8": "",
    "custom9": "",
    "custom10": "",
    "campaignid": "0",
    "programid": "0",
    "tourid": "1",
    "optionid": "0",
    "adtoolid": "0",
    "subid1": "0",
    "subid2": "0",
    "billerid": "0",
    "countryid": "0",
    "promotionalid": "0",
    "loginid_nice": "Type-In",
    "programid_nice": "Type-In",
    "campaignid_nice": "Default",
    "campaign_name": "Default",
    "siteid_nice": "member_a",
    "tourid_nice": "Default Tour",
    "flagged": "0"
  }
}