Employee::findAll | TUNE Dev Hub

Jump to: GET Response Notes | API Call Builder

Retrieves a list of all network employees.

= 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
access	An array of permissions that the Employee has. This array contains a value "Brand" that grants base Employee permissions. Other possible permissions are: "Brand.stats" (Ability to view stats, graphs and reports), "Brand.billing" (Ability to view and maintain billing information), "Brand.offer_management" (Ability to edit offer information), "Brand.affiliate_management" (Ability to manage affiliate accounts), "Brand.lead_management" (Ability to manage the conversions for an account/offer), "Brand.global_management" (Ability to use permissions across all accounts and not just specifically accounts the Employee directly manages), "Brand.brand_management" (Ability to manage brand preferences and customization), "Brand.virtual_user" (Ability to virtual user as an affiliate), "Brand.file_management" (Ability to manage offer files), "Brand.offer_monitor_management" (Ability to manage offer monitors), "Brand.alert_management" (Ability to manage alerts), "Brand.dne_management" (Ability to manage DNE lists), "Brand.employee_management" (ability to add,edit,delete employees), "Brand.advertiser_management" (Ability to manage advertiser accounts).
aim	The Employee's chat alias
billing_user	Whether or not the Employee can access and modify the Network's HasOffers billing details
cell_phone	The Employee's cell phone
email	The Employee's email address
first_name	The Employee's first name
id	A unique, auto-generated ID for the Employee
join_date	The date the Employee was created
last_login	The last time the Employee logged into the application
last_name	The Employee's last name
modified	The last time the Employee account was updated
password	The Employee's password
password_confirmation	Provided on creation and must match the provided "password" field
permissions	The Employee's permissions stored as a bitmask. See the "access" field for readable permission names. This should not be set or updated directly; instead, the Employee::grantAccess and Employee::removeAccess API functions should be used to grant to, and revoke permissions from, Employees.
phone	The Employee's phone number
photo	A URL pointing to an image of the Employee's photograph
status	The Employee status
title	The Employee's title
wants_alerts	DEPRECATED. This field should be ignored.

Show 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
Employee.access	An array of permissions that the Employee has. This array contains a value "Brand" that grants base Employee permissions. Other possible permissions are: "Brand.stats" (Ability to view stats, graphs and reports), "Brand.billing" (Ability to view and maintain billing information), "Brand.offer_management" (Ability to edit offer information), "Brand.affiliate_management" (Ability to manage affiliate accounts), "Brand.lead_management" (Ability to manage the conversions for an account/offer), "Brand.global_management" (Ability to use permissions across all accounts and not just specifically accounts the Employee directly manages), "Brand.brand_management" (Ability to manage brand preferences and customization), "Brand.virtual_user" (Ability to virtual user as an affiliate), "Brand.file_management" (Ability to manage offer files), "Brand.offer_monitor_management" (Ability to manage offer monitors), "Brand.alert_management" (Ability to manage alerts), "Brand.dne_management" (Ability to manage DNE lists), "Brand.employee_management" (ability to add,edit,delete employees), "Brand.advertiser_management" (Ability to manage advertiser accounts).
Employee.aim	The Employee's chat alias
Employee.billing_user	Whether or not the Employee can access and modify the Network's HasOffers billing details
Employee.cell_phone	The Employee's cell phone
Employee.email	The Employee's email address
Employee.first_name	The Employee's first name
Employee.id	A unique, auto-generated ID for the Employee
Employee.join_date	The date the Employee was created
Employee.last_login	The last time the Employee logged into the application
Employee.last_name	The Employee's last name
Employee.modified	The last time the Employee account was updated
Employee.password	The Employee's password
Employee.password_confirmation	Provided on creation and must match the provided "password" field
Employee.permissions	The Employee's permissions stored as a bitmask. See the "access" field for readable permission names. This should not be set or updated directly; instead, the Employee::grantAccess and Employee::removeAccess API functions should be used to grant to, and revoke permissions from, Employees.
Employee.phone	The Employee's phone number
Employee.photo	A URL pointing to an image of the Employee's photograph
Employee.status	The Employee status
Employee.title	The Employee's title
Employee.wants_alerts	DEPRECATED. This field should be ignored.

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

fields

Array

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

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

Name	Description
access	An array of permissions that the Employee has. This array contains a value "Brand" that grants base Employee permissions. Other possible permissions are: "Brand.stats" (Ability to view stats, graphs and reports), "Brand.billing" (Ability to view and maintain billing information), "Brand.offer_management" (Ability to edit offer information), "Brand.affiliate_management" (Ability to manage affiliate accounts), "Brand.lead_management" (Ability to manage the conversions for an account/offer), "Brand.global_management" (Ability to use permissions across all accounts and not just specifically accounts the Employee directly manages), "Brand.brand_management" (Ability to manage brand preferences and customization), "Brand.virtual_user" (Ability to virtual user as an affiliate), "Brand.file_management" (Ability to manage offer files), "Brand.offer_monitor_management" (Ability to manage offer monitors), "Brand.alert_management" (Ability to manage alerts), "Brand.dne_management" (Ability to manage DNE lists), "Brand.employee_management" (ability to add,edit,delete employees), "Brand.advertiser_management" (Ability to manage advertiser accounts).
aim	The Employee's chat alias
billing_user	Whether or not the Employee can access and modify the Network's HasOffers billing details
cell_phone	The Employee's cell phone
email	The Employee's email address
first_name	The Employee's first name
id	A unique, auto-generated ID for the Employee
join_date	The date the Employee was created
last_login	The last time the Employee logged into the application
last_name	The Employee's last name
modified	The last time the Employee account was updated
password	The Employee's password
password_confirmation	Provided on creation and must match the provided "password" field
permissions	The Employee's permissions stored as a bitmask. See the "access" field for readable permission names. This should not be set or updated directly; instead, the Employee::grantAccess and Employee::removeAccess API functions should be used to grant to, and revoke permissions from, Employees.
phone	The Employee's phone number
photo	A URL pointing to an image of the Employee's photograph
status	The Employee status
title	The Employee's title
wants_alerts	DEPRECATED. This field should be ignored.

Show Supported Values

GET Response Notes

Returns a list of Employee model objects.

API Call Builder

Javascript is required to use the API Call Builder.