/api/affiliate/search

get

Search affiliates

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

as_arraystringOptional

countintegerOptional

endanyOptional

orderbyanyOptional

output_formatanyOptional

return_payvia_infoanyOptional

return_referred_infoanyOptional

return_group_enabledintegerOptional

return_payout_period_enabledintegerOptional

return_program_enabledintegerOptional

return_referring_infoanyOptional

return_w9stringOptional

startintegerOptional

widgetstringOptionalDefault: 0

downloadstringOptionalDefault: 0

addressstringOptional

address_comparestringOptionalDefault: =

citystringOptional

city_comparestringOptionalDefault: =

companystringOptional

company_comparestringOptionalDefault: =

countrystringOptional

country_comparestringOptionalDefault: =

deletedstringOptional

email_comparestringOptionalDefault: =

emailstringOptional

firstname_comparestringOptionalDefault: =

firstnamestringOptional

groupidintegerOptional

groupid_comparestringOptionalDefault: =

group_disabledintegerOptional

group_enabledintegerOptional

inhousestringOptional

join_countanyOptional

join_dateanyOptional

join_hitsanyOptional

join_ipanyOptional

join_rangeanyOptional

join_submitsanyOptional

lastname_comparestringOptionalDefault: =

lastnamestringOptional

login_dateanyOptional

loginid_comparestringOptionalDefault: =

loginidintegerOptional

login_ipanyOptional

login_rangeanyOptional

min_payanyOptional

namestringOptional

name_comparestringOptionalDefault: =

natscode_comparestringOptionalDefault: =

natscodestringOptional

pay_rangeanyOptional

payvia_detailsanyOptional

payvia_type_idanyOptional

payout_period_disabledintegerOptional

payout_period_enabledintegerOptional

program_disabledintegerOptional

program_enabledintegerOptional

ratioanyOptional

raw_hitsanyOptional

rebill_countanyOptional

refidanyOptional

refanyOptional

refund_countanyOptional

sales_repanyOptional

search_refanyOptional

teamsstringOptional

telegramstringOptional

gchatstringOptional

state_comparestringOptionalDefault: =

statestringOptional

stats_endanyOptional

stats_periodanyOptional

stats_startanyOptional

statusintegerOptional

status_comparestringOptionalDefault: =

text_searchanyOptional

total_earnedanyOptional

totalanyOptional

typeintegerOptional

unq_hitsanyOptional

urlanyOptional

username_comparestringOptionalDefault: like

usernamestringOptional

zip_code_comparestringOptionalDefault: =

zip_codestringOptional

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

get

/api/affiliate/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(
		'count' => 1000,
		'start' => 0,
		'status' => 0,
		'deleted' => 1
	);

$request = array(
	'method' => 'GET',
	'path' => 'affiliate/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

[
  {
    "loginid": "1",
    "username": "productsupport",
    "deleted": "0",
    "type": "225",
    "skinid": "102",
    "payvia_type_id": "1",
    "status": "0",
    "join_date": "1533153053",
    "inhouse": "0",
    "api_key": "",
    "tmmid": "0",
    "origin": "0",
    "language": "",
    "payout_period_id": "0",
    "2fa_enabled": "0",
    "firstname": "TMM",
    "lastname": "Support",
    "email": "[e-mail]",
    "date_posted": "1533153053",
    "join_ip": "0",
    "last_login": null,
    "last_login_ip": "",
    "reviewed": "0",
    "minimum_payout": "0",
    "bonus": "0",
    "bonus_used": "0",
    "verify": "",
    "reason": "",
    "unencoded": "0",
    "startpage": "internal.php",
    "rep_baseline": "0",
    "company": "Too Much Media",
    "url": "",
    "tel": "",
    "icq": "",
    "aim": "",
    "msn": "",
    "address1": null,
    "address2": null,
    "city": "",
    "state": "",
    "country": "",
    "zip_code": "",
    "tax_id_or_ssn": "",
    "invoicer": "0",
    "req_docs": "0",
    "w9": "0",
    "mailok": "0",
    "trust_level": "0",
    "new_notification": "0",
    "latest_news": "0",
    "default_campaign": "0",
    "default_program": "0",
    "default_site": "0",
    "pv_instant": "0",
    "payout_approval": "0",
    "access_preset": "0",
    "custom1": "0",
    "custom2": "0",
    "custom3": "0",
    "custom4": "0",
    "custom5": "0",
    "avatar_ext": "",
    "remote_access": "0",
    "remote_payment": "0",
    "remote_adtool": "0",
    "allow_subscription_passthrough": "0",
    "allow_option_force": "0",
    "admin_overview_affiliates_order": null,
    "admin_overview_sites_order": null,
    "tos_time": null,
    "tos_ip": null,
    "status_nice": "Active",
    "custom_permissions": 0
  },
  {
    "loginid": "2",
    "username": "tmmvaffiliate",
    "deleted": "0",
    "type": "225",
    "skinid": "102",
    "payvia_type_id": "1",
    "status": "0",
    "join_date": "1533153134",
    "inhouse": "0",
    "api_key": "",
    "tmmid": "0",
    "origin": "0",
    "language": "",
    "payout_period_id": "0",
    "2fa_enabled": "0",
    "firstname": "Test",
    "lastname": "Acct",
    "email": "[e-mail]",
    "date_posted": "1533153134",
    "join_ip": "3232235862",
    "last_login": "1533153175",
    "last_login_ip": "3232235862",
    "reviewed": "0",
    "minimum_payout": "50",
    "bonus": "0",
    "bonus_used": "0",
    "verify": "",
    "reason": "",
    "unencoded": "0",
    "startpage": "internal.php",
    "rep_baseline": "0",
    "company": "TMM",
    "url": "www.toomuchmedia.com",
    "tel": "",
    "icq": "",
    "aim": "",
    "msn": "",
    "address1": "23 Main St",
    "address2": null,
    "city": "Springfield",
    "state": "MO",
    "country": "US",
    "zip_code": "65619",
    "tax_id_or_ssn": "",
    "invoicer": "0",
    "req_docs": "0",
    "w9": "0",
    "mailok": "1",
    "trust_level": "0",
    "new_notification": "0",
    "latest_news": "0",
    "default_campaign": "0",
    "default_program": "0",
    "default_site": "0",
    "pv_instant": "0",
    "payout_approval": "0",
    "access_preset": "0",
    "custom1": "0",
    "custom2": "0",
    "custom3": "0",
    "custom4": "0",
    "custom5": "0",
    "avatar_ext": "",
    "remote_access": "0",
    "remote_payment": "0",
    "remote_adtool": "0",
    "allow_subscription_passthrough": "0",
    "allow_option_force": "0",
    "admin_overview_affiliates_order": null,
    "admin_overview_sites_order": null,
    "tos_time": null,
    "tos_ip": null,
    "status_nice": "Active",
    "custom_permissions": 0
  },
  {
    "loginid": "4",
    "username": "AccountRep",
    "deleted": "0",
    "type": "100",
    "skinid": "102",
    "payvia_type_id": "1",
    "status": "0",
    "join_date": "1565382535",
    "inhouse": "0",
    "api_key": "",
    "tmmid": "0",
    "origin": "0",
    "language": "en",
    "payout_period_id": "0",
    "2fa_enabled": "0",
    "firstname": "Account",
    "lastname": "Rep",
    "email": "[e-mail]",
    "date_posted": "1565382535",
    "join_ip": "0",
    "last_login": null,
    "last_login_ip": "",
    "reviewed": "0",
    "minimum_payout": "1",
    "bonus": "0",
    "bonus_used": "0",
    "verify": "",
    "reason": "",
    "unencoded": "0",
    "startpage": "internal.php",
    "rep_baseline": "0",
    "company": "TMM",
    "url": "toomuchmedia.com",
    "tel": "111-111-1111",
    "icq": "111111111",
    "aim": "testaffiliate",
    "msn": "testaffiliate",
    "address1": "1 affiliate st",
    "address2": null,
    "city": "City",
    "state": "State",
    "country": "US",
    "zip_code": "11111",
    "tax_id_or_ssn": "111111111",
    "invoicer": "0",
    "req_docs": "0",
    "w9": "0",
    "mailok": "0",
    "trust_level": "0",
    "new_notification": "0",
    "latest_news": "0",
    "default_campaign": "0",
    "default_program": "0",
    "default_site": "0",
    "pv_instant": "0",
    "payout_approval": "0",
    "access_preset": "0",
    "custom1": "0",
    "custom2": "0",
    "custom3": "0",
    "custom4": "0",
    "custom5": "0",
    "avatar_ext": "",
    "remote_access": "0",
    "remote_payment": "0",
    "remote_adtool": "0",
    "allow_subscription_passthrough": "0",
    "allow_option_force": "0",
    "admin_overview_affiliates_order": null,
    "admin_overview_sites_order": null,
    "tos_time": null,
    "tos_ip": null,
    "status_nice": "Active",
    "custom_permissions": 0
  },
  {
    "loginid": "3",
    "username": "affiliateTest",
    "deleted": "0",
    "type": "0",
    "skinid": "102",
    "payvia_type_id": "1",
    "status": "0",
    "join_date": "1565382535",
    "inhouse": "0",
    "api_key": "",
    "tmmid": "0",
    "origin": "0",
    "language": "en",
    "payout_period_id": "0",
    "2fa_enabled": "0",
    "firstname": "Test",
    "lastname": "Affiliate",
    "email": "[e-mail]",
    "date_posted": "1565382535",
    "join_ip": "0",
    "last_login": null,
    "last_login_ip": "",
    "reviewed": "0",
    "minimum_payout": "1",
    "bonus": "0",
    "bonus_used": "0",
    "verify": "",
    "reason": "",
    "unencoded": "0",
    "startpage": "internal.php",
    "rep_baseline": "0",
    "company": "TMM",
    "url": "toomuchmedia.com",
    "tel": "111-111-1111",
    "icq": "111111111",
    "aim": "testaffiliate",
    "msn": "testaffiliate",
    "address1": "1 affiliate st",
    "address2": null,
    "city": "City",
    "state": "State",
    "country": "US",
    "zip_code": "11111",
    "tax_id_or_ssn": "111111111",
    "invoicer": "0",
    "req_docs": "0",
    "w9": "0",
    "mailok": "0",
    "trust_level": "0",
    "new_notification": "0",
    "latest_news": "0",
    "default_campaign": "0",
    "default_program": "0",
    "default_site": "0",
    "pv_instant": "0",
    "payout_approval": "0",
    "access_preset": "0",
    "custom1": "0",
    "custom2": "0",
    "custom3": "0",
    "custom4": "0",
    "custom5": "0",
    "avatar_ext": "",
    "remote_access": "0",
    "remote_payment": "0",
    "remote_adtool": "0",
    "allow_subscription_passthrough": "0",
    "allow_option_force": "0",
    "admin_overview_affiliates_order": null,
    "admin_overview_sites_order": null,
    "tos_time": null,
    "tos_ip": null,
    "status_nice": "Active",
    "custom_permissions": 0
  }
]