List Employees
Retrieve a list of employees in BambooHR.
Options
Field | Definition | Type | Required |
---|---|---|---|
Result Set |
Choose one of the following options to display your search results:
|
Dropdown |
TRUE |
Input
Field | Definition | Type |
---|---|---|
Only Current |
If True, the report results include only current employees. If False, the report includes future-dated employees. |
True/False |
Last Changed |
The most recent date and time the employee record changed, in ISO8601 format. For example, 2024-01-01T07:12:44+00:00. The results include only employees whose records have changed since this time. |
Text |
Include Null Dates? |
If Yes, the report results include employees with a null or empty value for the Last Changed field. If No, then the report only includes employees with a value for the Last Changed field. |
Dropdown |
Output
Field |
Definition |
Type |
---|---|---|
ACA Status |
The employee's ACA (Affordable Care Act) status. This field can't be updated directly but is calculated based on mappings for employment status found on the employmentStatus table. Available states: contractor, full-time, intern-eligible, intern-ineligible, part-time-eligible, part-time-ineligible, or seasonal. |
Text |
Address Line 1 |
The employee's first address line. |
Text |
Address Line 2 |
The employee's second address line. |
Text |
Age |
The employee's age. Changing this value requires an update to the Birth Date field. |
Text |
Best Email |
The employee's work email if set, otherwise their home email. |
Text |
Birth Date |
The date the employee was born. |
Text |
Birthday |
The employee's month and day of birth. Changing this value requires an update to the Birth Date field. |
Text |
Bonus Amount |
The amount of the most recent bonus. |
Text |
Bonus Comment |
Comment about the most recent bonus. |
Text |
Bonus Date |
The date of the last bonus. |
Text |
Bonus Reason |
The reason for the most recent bonus. |
Text |
City |
The employee's city. |
Text |
Commission Amount |
The amount of the most recent commission. |
Text |
Commission Comment |
Comment about the most recent commission. |
Text |
Commission Date |
The date of the last commission. |
Text |
Compensation Change Reason |
Reason for the most recent compensation change. |
Text |
Compensation: Date |
The date of the last compensation. |
Text |
Country |
The employee's country. |
Text |
Created By User ID |
The identifier of the user who created the employee. This is a read-only value. This may be null if the employee was created before this field was added. |
Text |
Department |
The employee's current department. |
Text |
Display Name |
The employee's name, displayed in a format configured by the user. This is a read-only value. |
Text |
Division |
The employee's current division. |
Text |
EEO Job Category |
The employee's EEO job category. The US Equal Employment Opportunity Commission defines these categories. |
Text |
Employee # |
The employee number assigned by your company. |
Text |
Employment Status |
The employee's current employment status. Options are customized by account. This is a read-only value. |
Text |
Ethnicity |
The employee's ethnicity. |
Text |
First & Last Name |
The employee's first and family name. For example, John Doe. This is a read-only value. |
Text |
First Name |
The employee's first name. |
Text |
Full Name (First, Last) |
The employee's full name without their preferred name, first name first. For example, John Quentin Doe. This is a read-only value. |
Text |
Full Name (Last, First) |
The employee's full name without their preferred name, family name first. For example, Doe, John Quentin. This is a read-only value. |
Text |
Full Name (Last, First) & Preferred |
The employee's full name and their preferred name. For example, Doe, John Quentin (JDog). This is a read-only value. |
Text |
Gender |
The employee's gender: Male or Female. |
Text |
Hire Date |
The date the employee was hired. |
Text |
Home Email |
The employee's home email address. |
Text |
Home Phone |
The employee's home phone number. |
Text |
ID |
The employee ID automatically assigned by BambooHR. This is a read-only value. |
Text |
Include in Payroll |
Should employee be included in payroll: Yes or No. |
Text |
Is Photo Uploaded |
Whether a photo has been uploaded for the employee. This is a read-only value. |
Text |
Job Title |
The current value of the employee's job title. Updating this field creates a new row in the position history. |
Text |
Last & First Name |
The employee's last and first name. For example, Doe, John. This is a read-only value. |
Text |
Last Changed |
The date and time of the last change to the employee record. |
Text |
Last Name |
The employee's family name. |
Text |
Location |
The employee's current location. |
Text |
Marital Status |
The employee's marital status: Single, Married, or Domestic Partnership. |
Text |
Middle Name |
The employee's middle name. |
Text |
Mobile Phone |
The employee's mobile phone number. |
Text |
NIN |
The employee's NIN number. |
Text |
National ID |
The employee's National ID number. |
Text |
Nationality |
The employee's nationality. |
Text |
Original Hire Date |
The date the employee was originally hired. |
Text |
Overtime Status |
The FLSA Overtime Status: Exempt or Non-exempt. |
Text |
Pay Frequency |
The employee's current pay frequency: Weekly, Every other week, Twice a month, Monthly, Quarterly, Twice a year, or Yearly. |
Text |
Pay Group |
The custom pay group to which the employee belongs. |
Text |
Pay Group ID |
The ID value corresponding to the pay group to which an employee belongs. |
Text |
Pay Period |
The employee's current pay per: Hour, Day, Week, Month, Quarter, or Year. |
Text |
Pay Rate |
The employee's current pay rate. For example, $8.25. |
Text |
Pay Schedule |
The employee's current pay schedule. |
Text |
Pay Schedule ID |
The ID value corresponding to the pay schedule that an employee belongs to. |
Text |
Pay Type |
The employee's current pay type: hourly, salary, commission, exception hourly, monthly, weekly, piece rate, contract, daily, or pro rata. |
Text |
Preferred Name |
The employee's preferred name. |
Text |
SIN |
The employee's Canadian Social Insurance Number. |
Text |
SSN |
The employee's Social Security number. |
Text |
Standard Hours Per Week |
The number of hours the employee works in a standard week. |
Text |
State |
The employee's state or province. |
Text |
State Code |
The 2 character abbreviation for the employee's state (US only). This is a read-only value. |
Text |
Status |
The employee's employee status: Active or Inactive. |
Text |
Supervisor |
The employee's current supervisor. This is a read-only value. |
Text |
Supervisor Email |
The email of the employee's current supervisor. This is a read-only value. |
Text |
Supervisor Employee ID |
The ID of the employee's current supervisor. This is a read-only value. |
Text |
Supervisor Employee Number |
The employee number of the employee's current supervisor. This is a read-only value. |
Text |
Termination Date |
The date the employee was terminated. Read-only. |
Text |
Time Tracking Enabled |
Should time tracking be enabled for the employee: Yes or No. |
Text |
Work Email |
The employee's work email address. |
Text |
Work Ext. |
The employee's work phone extension (if any). |
Text |
Work Phone |
The employee's work phone number, without extension. |
Text |
Work Phone + Extension |
The employee's work phone and extension. This is a read-only value. |
Text |
Zip Code |
The employee's ZIP code. |
Text |