Field Names

API Field Name	Type	Description
acaStatus	text	Deprecated please use ‘acaStatusCategory’.
acaStatusCategory	text	The employee's ACA (Affordable Care Act) status. This field can not be updated directly but is calculated based on mappings for employment statuses found on the employmentStatus table. Options are: "contractor", "full-time", "intern-eligible", "intern-ineligible", "part-time-eligible", "part-time-ineligible", "seasonal".
address1	text	The employee's first address line. Contacts: the first address line of an employee's contact. Dependents: the first address line of an employee's dependent.
address2	text	The employee's second address line. Contacts: the second address line of an employee's contact. Dependents: the second address line of an employee's dependent.
age	integer	The employee's age. To change age, update dateOfBirth field.
amount	currency	Bonus: the dollar amount of an employee's bonus. Commission: the dollar amount of an employee's commission.
bestEmail	email	The employee's work email if set, otherwise their home email.
birthday	text	The employee's month and day of birth. To change birthday, update dateOfBirth field.
bonusAmount	currency	The amount of the most recent bonus.
bonusComment	text	Comment about the most recent bonus.
bonusDate	date	The date of the last bonus.
bonusReason	list	The reason for the most recent bonus.
category	list	Employee Assets: The category of an employee's asset.
certificationNumber	text	The identification number of an employee's certification.
city	text	The employee's city. Contacts: the city of an employee's contact. Dependents: the city of an employee's dependent.
cliffMonths	integer	The number of months until an employee can receive any ownership of their equity grant.
comment	textarea	Field for additional comments in the bonus, commission, compensation, and employmentStatus tables.
comments	textarea	Field for additional comments in the employeeStockOptions table.
commissionAmount	currency	The amount of the most recent commission.
commissionComment	text	Comment about the most recent commission.
commissionDate	date	The date of the last commission.
commisionDate	date	This field name contains a typo, and exists for backwards compatibility.
completionDate	date	Employee Certification: the date that the certification was completed.
cost	currency	Employee Assets: the asset's cost.
country	country	The employee's country. Contacts: the country of an employee's contact. Dependents: the country of an employee's dependent. Employee Visa: the issuing country of an employee's visa.
createdByUserId	integer	The id of the user who created the employee. Read only. May be null if employee was created before the release of this field.
customGrantTypeName	text	Custom name given to this equity grant.
date	date	Bonus: The date that an employee earned a bonus. Commission: The date that an employee earned a commission. Earnings: The date of employee earnings. Employee Visa: Sorting date. Employment Status: the date that an employee gained a new status. Job Info: the date of an employee's role.
dateLoaned	date	The date that an asset was loaned to an employee.
dateOfBirth	date	The date the employee was born. Dependents: the date that the employee's dependent was born.
dateReturned	date	The date that an asset was returned by an employee.
degree	list	The type of degree pursued and/or attained through an employee's education. ie: "Associate's", "Bachelor's", "Doctorate", "Master's", or custom.
department	list	The employee's current (unless accessing Job History table) department.
description	text	Employee Assets: the description of an employee's asset.
displayName	text	The employee's name displayed in a format configured by the user. Read only.
division	list	The employee's current (unless accessing Job History table) division.
eeo	list	The employee's EEO job category. These are defined by the U.S. Equal Employment Opportunity Commission.
ein	ein	The employee's Employee Identification number.
email	email	The email address of an employee's contact.
employeeNumber	text	Employee number (assigned by your company).
employmentHistoryStatus	list	The employee's current employment status. Options are customized by account. Read-only starting with version 1.1; update using the employmentStatus table.
employmentStatus	list	The employee's employment status. ie: "Contractor", "Full-Time", "Furloughed", "Part-Time", "Terminated", or custom.
endDate	date	Employee Education: the date that an employee graduated, or otherwise stopped attending school. Compensation: the date that an employee stopped earning a specific compensation rate.
ethnicity	list	The employee's ethnicity.
exempt	exempt	The FLSA Overtime Status (Exempt or Non-exempt).
expirationDate	date	Employee Certification: the expiration date of a certification.
expires	date	Employee Visa: the expiration date of a visa.
expiryDate	passport_expiry	The expiration date of an employee's passport.
firstName	text	The employee's first name. Dependents: the first name of an employee's dependent.
flsaCode	list	Deprecated please use 'exempt'.
fullName1	text	The employee's first and last name. (e.g., John Doe). Read only.
fullName2	text	The employee's last and first name. (e.g., Doe, John). Read only.
fullName3	text	The employee's full name and their preferred name. (e.g., Doe, John Quentin (JDog)). Read only.
fullName4	text	The employee's full name without their preferred name, last name first. (e.g., Doe, John Quentin). Read only.
fullName5	text	The employee's full name without their preferred name, first name first. (e.g., John Quentin Doe). Read only.
gender	gender	The employee's gender. ie: "Male", "Female", or "Non-binary" (If expanded gender options are enabled). Dependents: the gender of an employee's dependent.
gpa	text	The gpa attained by an employee at one educational institution.
grantDate	date	The date that an employee was initially awarded the equity grant or stock options.
grantTypeId	list	The type of equity grant. ie: "ISO", "MIU", "NSO", "RSA", "RSU".
hireDate	date	The date the employee was hired.
homeEmail	email	The employee's home email address.
homePhone	phone	The employee's home phone number. Contact: the home phone number of an employee's contact. Dependents: the home phone number of an employee's dependent.
id	integer	The employee ID automatically assigned by BambooHR. Read only.
includeInPayroll	bool	Should employee be included in payroll (Yes or No).
isPhotoUploaded	bool	Whether a photo has been uploaded for the employee. Read only.
issued	date	Employee Visa: The issue date of a visa.
issuedDate	passport_issued	The date that an employee's passport expired
issuingCountry	country	The country that issued an employee's passport.
jobTitle	list	The current (unless accessing Job History table) value of the employee's job title, updating this field will create a new row in position history.
lastChanged	timestamp	The date and time that the employee record was last changed.
lastName	text	The employee's last name. Dependents: the last name of an employee's dependent.
location	list	The employee's current (unless accessing Job History table) location.
major	text	The major or specialization that an employee attained through education.
maritalStatus	list	The employee's marital status. ie: "Single", "Married", or "Domestic Partnership".
middleName	text	The employee's middle name. Dependents: the middle name of an employee's dependent.
mobilePhone	phone	The employee's mobile phone number. Contacts: the mobile phone number of an employee's contact.
name	text	The name of an employee's contact.
nationalId	national_id	The employee's National ID number.
nationality	list	The employee's nationality.
nin	nin	The employee's NIN number.
note	text	Field for additional notes in the employeeVisas table
notes	text	Field for additional notes in the employeeAssets table.
notes	textarea	Field for additional notes in the employeeCertifications table.
numberOfEquityGranted	integer	The number of ownership-units given to an employee through an equity grant.
numberOptionsGranted	text	The number of stock options provided to an employee.
optionPrice	currency	The cost to buy or sell stock options.
originalHireDate	date	The date the employee was originally hired. Available starting with version 1.1.
overtimeRate	currency	An employee's pay rate for overtime work. Note that the 'exempt' field must be set to "Non-exempt" for this to update.
paidPer	paid_per	The employee's current (unless accessing Compensation History table) pay per. ie: "Hour", "Day", "Week", "Month", "Quarter", "Year".
passportNumber	passport_number	The passport number.
payChangeReason	list	The reason for the employee's last pay rate change.
payGroup	list	The custom pay group that the employee belongs to.
payGroupId	integer	The ID value corresponding to the pay group that an employee belongs to.
payRate	currency	The employee's current pay rate (e.g., $8.25).
payRateEffectiveDate	date	The day the most recent change was made.
payType	pay_type	The employee's current pay type. ie: "hourly", "salary", "commission", "exception hourly", "monthly", "weekly", "piece rate", "contract", "daily", "pro rata".
payFrequency	list	The employee's current pay frequency. ie: "Weekly", "Every other week", "Twice a month", "Monthly", "Quarterly", "Twice a year", or "Yearly"
paySchedule	list	The employee's current (unless accessing Compensation History table) pay schedule.
payScheduleId	integer	The ID value corresponding to the pay schedule that an employee belongs to.
plan	list	The benefit plan that gives the employee the right to purchase stock options.
preferredName	text	The employee's preferred name.
primaryContact	checkbox	Is this contact the employee's primary contact?
priorYear	currency	The amount earned by an employee. This field is relevant for W2 and K1 tax forms.
rate	currency	The amount of money an employee is earning per hour or salary.
reason	list	Bonus: the reason for an employee's bonus. Compensation: the reason for a change in an employee's compensation.
relationship	list	The relationship of an employee with their contact. ie: "Brother", "Daughter", "Father", "Friend", "Husband", "Mother", "Sister", "Son", "Wife", or custom.
relationship	relationship	The relationship of an employee with their dependent. ie: "Spouse", "Domestic partner", "Child", "Foster child", "Step child".
reportsTo	employee	The employee's manager.
school	text	The school that an employee attended.
serialNumber	text	Employee Assets: the serial number of an employee's asset.
sin	sin	The employee's Canadian Social Insurance Number.
ssn	ssn	The employee's Social Security number. Dependents: the Social Security number of an employee's dependent.
standardHoursPerWeek	integer	The number of hours the employee works in a standard week.
startDate	date	Employee Education: the date that an employee started at a school. Compensation: the date that an employee started earning a certain compensation rate.
state	state	The employee's state/province. Contacts: the state/province of an employee's contact. Dependents: the state/province of an employee's dependent.
stateCode	text	The 2 character abbreviation for the employee's state (US only). Read only.
status	status	The employee's employee status Options are: "Active", "Inactive".
strikePrice	currency	The cost per ownership-unit of an equity grant.
supervisor	employee	The employee’s current supervisor. Read only.
supervisorEId	integer	The ID of the employee's current supervisor. Read only.
supervisorEmail	text	The email of the employee's current supervisor. Read only.
supervisorId	integer	The 'employeeNumber' of the employee's current supervisor. Read only.
terminationDate	date	The date the employee was terminated. Read-only starting with version 1.1; update using the employmentStatus table.
terminationRegrettable	list	Whether or not an employee's termination was regrettable by the company. This is only relevant if an employee's employment status is being updated to "Terminated" and the terminationType is "Resignation". Options are: "Regrettable" or "Non-Regrettable".
terminationRehireId	list	The employee's eligibility for rehire. This is only relevant if an employee's employment status is being updated to "Terminated". Options are: "Yes", "No", "Upon review".
terminationStatusId	list	The reason for the employee's termination. ie: "Attendance", "End of Season", "Other employment", "Performance", "Relocation". This is only relevant if an employee's employment status is being updated to 'Terminated'.
terminationTypeId	list	The type of an employee's termination. This is only relevant if an employee's employment status is being updated to 'Terminated'. Options are: "Death", "Resignation (Voluntary)", "Termination (Involuntary)".
timeTrackingEnabled	bool	Should time tracking be enabled for the employee (Yes or No).
title	list	Employee Certifications: The name of the certification.
type	pay_type	The the unit of pay for an employee. Options are: "Hourly", "Salary", or "Commission Only".
vestingDate	date	The date that an employee gains full ownership of stock options.
vestingGrantDate	date	The date that an employee gains full ownership of an equity grant.
vestingMonths	integer	The number of months until the employee has full ownership of an equity grant.
vestingScheduleId	list	The frequency of transferring an equity grant to an employee. Options are: "Annually", "Monthly", or "Quarterly".
visaType	list	The type of an employee's visa. ie: "B1", "B2", "H1B", "H2B", "L1A", "L1B", "Permanent Resident", "TN1".
workEmail	email	The employee's work email address.
workPhone	phone	The employee's work phone number, without extension. Contacts: the work phone number of an employee's contact, without extension.
workPhoneExtension	text	The employee's work phone extension (if any). Contacts: the work phone extension of an employee's contact.
workPhonePlusExtension	text	The employee's work phone and extension. Read only.
zipcode	text	The employee's ZIP code. Contacts: the ZIP code of an employee's contact. Dependents: the ZIP code of an employee's dependent.