Affiliate::simpleSearch

Jump to: GET Response Notes | API Call Builder

Paginated search against the affiliates table directly with no contains, virtual properties
attached to the response, etc.

= Required Parameter

Name

Type

Description

filters

Filter

Array of field values to filter results byShow Filterable Fields

The following fields from the model can be filtered on.

Name	Description
account_manager_id	The ID of the employee from the network who is assigned as the account manager for the affiliate
address1	The first line of the account's physical address
address2	The second line of the account's physical address
affiliate_tier_id	The ID of the affiliate tier to which this affiliate is assigned. If no value is present, the affiliate is in the default tier.
city	The city of the account's physical address
company	The company name of the affiliate
country	The country of the account's physical address
date_added	The date this account was created
fax	The fax number of the affiliate
fraud_activity_alert_threshold	The activity fraud threshold (percent out of 100) at which point an alerts will be generated for this account when its recent activity is flagged as potentially fraudulent. Applicable only if the "affiliate_fraud_activity" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_activity_block_threshold	The activity fraud threshold (percent out of 100) at which point the account will be automatically blocked (status set to "blocked") when its recent activity is flagged as potentially fraudulent. Applicable only if the "affiliate_fraud_activity" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_activity_score	Activity fraud score for the affiliate. Applicable only if the "affiliate_fraud_activity" preference is enabled. This should not be manually updated/overridden as the API will update this score automatically. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_alert_threshold	The profile fraud threshold (percent out of 100) at which point an alerts will be generated for this account when changes are made to it. Applicable only if the "affiliate_fraud_profile" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_block_threshold	The profile fraud threshold (percent out of 100) at which point the account will be automatically blocked (status set to "blocked"). Applicable only if the "affiliate_fraud_profile" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_score	Profile fraud score for the affiliate. Applicable only if the "affiliate_fraud_profile" preference is enabled. This should not be manually updated/overridden as the API will update this score automatically. For more information, reference our article on Affiliate Activity Fraud.
fraud_risk_tier	Fraud risk tier that classifies how likely this affiliate is to be fraudulent. 0: Low, 4: Critical
id	ID of unique object identifier for the affiliate
method_data	This parameter has been deprecated.
modified	The last time this account was updated
other	This parameter has been deprecated.
payment_method	The method by which payments are made to the affiliate. The network may restrict which methods are allowed. The payment method indicated by the "affiliate_payment_method_default" Preference.
payment_terms	The schedule by which invoices are generated for this affiliate. The terms indicated by the "affiliate_payment_terms_default" preference.
phone	The affiliate's phone number
ref_id	An external reference ID for this account
referral_id	The ID of the affiliate account that referred this one
region	The state/province of the account's physical address
signup_ip	The IP address the affiliate used to sign up from
status	The status of the account
w9_filed	Whether or not a W9 / W8-BEN is on file for this account
wants_alerts	This parameter has been deprecated.
website	This parameter has been deprecated.
zipcode	The zipcode / postal code of the account's physical address

Show Filterable Fields

fields

Array

List of fields to return; defaults to all fieldsShow Supported Values

Any of the following values from the Affiliate model are supported.

Name	Description
account_manager_id	The ID of the employee from the network who is assigned as the account manager for the affiliate
address1	The first line of the account's physical address
address2	The second line of the account's physical address
affiliate_tier_id	The ID of the affiliate tier to which this affiliate is assigned. If no value is present, the affiliate is in the default tier.
city	The city of the account's physical address
company	The company name of the affiliate
country	The country of the account's physical address
date_added	The date this account was created
fax	The fax number of the affiliate
fraud_activity_alert_threshold	The activity fraud threshold (percent out of 100) at which point an alerts will be generated for this account when its recent activity is flagged as potentially fraudulent. Applicable only if the "affiliate_fraud_activity" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_activity_block_threshold	The activity fraud threshold (percent out of 100) at which point the account will be automatically blocked (status set to "blocked") when its recent activity is flagged as potentially fraudulent. Applicable only if the "affiliate_fraud_activity" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_activity_score	Activity fraud score for the affiliate. Applicable only if the "affiliate_fraud_activity" preference is enabled. This should not be manually updated/overridden as the API will update this score automatically. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_alert_threshold	The profile fraud threshold (percent out of 100) at which point an alerts will be generated for this account when changes are made to it. Applicable only if the "affiliate_fraud_profile" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_block_threshold	The profile fraud threshold (percent out of 100) at which point the account will be automatically blocked (status set to "blocked"). Applicable only if the "affiliate_fraud_profile" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_score	Profile fraud score for the affiliate. Applicable only if the "affiliate_fraud_profile" preference is enabled. This should not be manually updated/overridden as the API will update this score automatically. For more information, reference our article on Affiliate Activity Fraud.
fraud_risk_tier	Fraud risk tier that classifies how likely this affiliate is to be fraudulent. 0: Low, 4: Critical
id	ID of unique object identifier for the affiliate
method_data	This parameter has been deprecated.
modified	The last time this account was updated
other	This parameter has been deprecated.
payment_method	The method by which payments are made to the affiliate. The network may restrict which methods are allowed. The payment method indicated by the "affiliate_payment_method_default" Preference.
payment_terms	The schedule by which invoices are generated for this affiliate. The terms indicated by the "affiliate_payment_terms_default" preference.
phone	The affiliate's phone number
ref_id	An external reference ID for this account
referral_id	The ID of the affiliate account that referred this one
region	The state/province of the account's physical address
signup_ip	The IP address the affiliate used to sign up from
status	The status of the account
w9_filed	Whether or not a W9 / W8-BEN is on file for this account
wants_alerts	This parameter has been deprecated.
website	This parameter has been deprecated.
zipcode	The zipcode / postal code of the account's physical address

Show Supported Values

limit

Integer

Objects per page to return; defaults to returning all found

page

Integer

Result page to return, based on limit value; defaults to 1

sort

Sort

Array of fields and directions to sort results byShow Sortable Fields

The following fields from the model can be sorted in either ascending (ASC) or descending (DESC) order.

Name	Description
account_manager_id	The ID of the employee from the network who is assigned as the account manager for the affiliate
address1	The first line of the account's physical address
address2	The second line of the account's physical address
affiliate_tier_id	The ID of the affiliate tier to which this affiliate is assigned. If no value is present, the affiliate is in the default tier.
city	The city of the account's physical address
company	The company name of the affiliate
country	The country of the account's physical address
date_added	The date this account was created
fax	The fax number of the affiliate
fraud_activity_alert_threshold	The activity fraud threshold (percent out of 100) at which point an alerts will be generated for this account when its recent activity is flagged as potentially fraudulent. Applicable only if the "affiliate_fraud_activity" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_activity_block_threshold	The activity fraud threshold (percent out of 100) at which point the account will be automatically blocked (status set to "blocked") when its recent activity is flagged as potentially fraudulent. Applicable only if the "affiliate_fraud_activity" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_activity_score	Activity fraud score for the affiliate. Applicable only if the "affiliate_fraud_activity" preference is enabled. This should not be manually updated/overridden as the API will update this score automatically. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_alert_threshold	The profile fraud threshold (percent out of 100) at which point an alerts will be generated for this account when changes are made to it. Applicable only if the "affiliate_fraud_profile" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_block_threshold	The profile fraud threshold (percent out of 100) at which point the account will be automatically blocked (status set to "blocked"). Applicable only if the "affiliate_fraud_profile" preference is enabled. For more information, reference our article on Affiliate Activity Fraud.
fraud_profile_score	Profile fraud score for the affiliate. Applicable only if the "affiliate_fraud_profile" preference is enabled. This should not be manually updated/overridden as the API will update this score automatically. For more information, reference our article on Affiliate Activity Fraud.
fraud_risk_tier	Fraud risk tier that classifies how likely this affiliate is to be fraudulent. 0: Low, 4: Critical
id	ID of unique object identifier for the affiliate
method_data	This parameter has been deprecated.
modified	The last time this account was updated
other	This parameter has been deprecated.
payment_method	The method by which payments are made to the affiliate. The network may restrict which methods are allowed. The payment method indicated by the "affiliate_payment_method_default" Preference.
payment_terms	The schedule by which invoices are generated for this affiliate. The terms indicated by the "affiliate_payment_terms_default" preference.
phone	The affiliate's phone number
ref_id	An external reference ID for this account
referral_id	The ID of the affiliate account that referred this one
region	The state/province of the account's physical address
signup_ip	The IP address the affiliate used to sign up from
status	The status of the account
w9_filed	Whether or not a W9 / W8-BEN is on file for this account
wants_alerts	This parameter has been deprecated.
website	This parameter has been deprecated.
zipcode	The zipcode / postal code of the account's physical address

Show Sortable Fields

GET Response Notes

Paginated results.

Return response will be in the following format: array.

API Call Builder

Javascript is required to use the API Call Builder.