Advertiser::findAll | TUNE Dev Hub

Jump to: GET Response Notes | API Call Builder

Returns one or more advertisers, optionally filtered and sorted by specified parameters.

= Required Parameter

Name

Type

Description

fields

Array

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

filters

Filter

Array of field values to filter results byShow Filterable Fields

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	ID of Employee object of Account Manager for this Advertiser
address1	The first line of the Advertiser's physical address
address2	The second line of the Advertiser's physical address
city	The city of the Advertiser's physical address
company	The company name of the Advertiser
conversion_security_token	The Advertiser Security Token that must be passed by the advertiser in order to register a conversion. Applicable only if the "enable_advertiser_security_token" Preference is enabled. For more information, see: https://support.hasoffers.com/hc/en-us/articles/202759308-Advertiser-Security-Token
country	The country of the Advertiser's physical address. ISO 3166-1 alpha-2 country code.
date_added	The date this Advertiser was created
fax	The fax number of the Advertiser
id	ID of unique, auto-generated object for this Advertiser
modified	The last time this Advertiser was updated
other	DEPRECATED. Ignore the contents of this field.
phone	The phone number of the Advertiser
ref_id	An external reference ID for this account
region	The state/province of the Advertiser's physical address
signup_ip	The IP address that the Advertiser used to sign up with
status	The status of the Advertiser account
tmp_token	Holds an Advertiser Security Token without enforcing it. This is where the security token should be placed until it can be communicated to the Advertiser and they update their application to pass it. After they update their code the token should be copied to the "conversion_security_token" field to enforce it. Applicable only if the "enable_advertiser_security_token" Preference is enabled. For more information, see: https://support.hasoffers.com/hc/en-us/articles/202759308-Advertiser-Security-Token
wants_alerts	DEPRECATED. Ignore the contents of this field.
website	DEPRECATED. Ignore the contents of this field.
zipcode	The zipcode / postal code of the Advertiser's physical address

Show Sortable Fields

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

contain

Contain

List of related objects to return with each resultShow Supported Values

GET Response Notes

List of Advertiser model instances matching criteria.

Return response will be in the following format: array.

API Call Builder

Javascript is required to use the API Call Builder.