There are a number of field types that are supported in the BambooHR system. The API attempts to balance the conflicting goals of providing the raw data for these fields in a machine readable format while simultaneously requiring as few API lookup calls as possible to accomplish a given task.
To eliminate the need for additional API requests, some data will be passed using human-readable plain text strings. Locale specific settings will be ignored in the API in order to provide a consistent machine readable format. All values are case insensitive.
A complete date with a four digit year.
Any valid UTF-8 sequence of characters.
Example: "I do not like green eggs and ham. I do not like them, Sam I am."
A standard United States Social Security number, with dashes.
A plain text string with a phone number, no formatting is enforced.
The plain text name of the gender.
Example: "Male" or "Female"
A simple quantity value without thousands separators or currency signs using a period as a decimal point.
The name of the country. Must exist in the BambooHR country list.
Example: "Australia", "United States", etc.
The full name of the state/province.
Plain text status of marriage.
Example: "Single" or "Married"
The employee's employment status as used to filter employees in BambooHR.
Example: "Active" or "Inactive"
One of several predefined options for the unit of pay.
Example: "Hourly", "Salary", "Commission", "Exception Hourly", "Monthly", "Piece Rate", "Contract" or "Daily"
A reference to another employee. Expressed as last name-comma-first name-space-middle name.
Example: "Smith, Robert James"
The UTC time that an event occured.
A larger section of text that can include line feed characters.
Example: "How much wood would a woodchuck chuck, if a woodchuck could chuck wood?"
The exact text for an option from a list.
An email address.
Example: "[email protected]"
A boolean value, true or false.
Enabled or Disabled
Have more questions? We're here to help, so please contact us.