Skip to main content
Server path: /bamboohr-employees | Type: Application | PCID required: Yes

Tools

ToolDescription
bamboohr_employees_create_company_file_categoryCreate Company File Category
bamboohr_employees_create_employeeCreate Employee
bamboohr_employees_create_employee_file_categoryCreate Employee File Category
bamboohr_employees_create_locationCreate a job location
bamboohr_employees_create_table_rowCreate Table Row
bamboohr_employees_create_table_row_v1_1Create Table Row v1.1
bamboohr_employees_delete_company_fileDelete Company File
bamboohr_employees_delete_employee_fileDelete Employee File
bamboohr_employees_delete_employee_table_rowDelete Employee Table Row
bamboohr_employees_delete_locationDelete a job location
bamboohr_employees_get_changed_employee_idsGet Changed Employee IDs
bamboohr_employees_get_changed_employee_table_dataGet Changed Employee Table Data
bamboohr_employees_get_company_fileGet Company File
bamboohr_employees_get_company_informationGet Company Information
bamboohr_employees_get_company_profile_integrationsGet Company Profile Integrations
bamboohr_employees_get_countries_optionsGet Countries
bamboohr_employees_get_directoryGet Employees Directory
bamboohr_employees_get_employeeGet Employee
bamboohr_employees_get_employee_fileGet Employee File
bamboohr_employees_get_employee_photoGet Employee Photo
bamboohr_employees_get_employee_table_dataGet Employee Table Data
bamboohr_employees_get_locationGet a job location
bamboohr_employees_get_locationsList job locations
bamboohr_employees_get_states_by_country_idGet States by Country ID
bamboohr_employees_list_company_filesGet Company Files and Categories
bamboohr_employees_list_employee_filesList Employee Files
bamboohr_employees_list_employeesList Employees
bamboohr_employees_list_fieldsList Fields
bamboohr_employees_list_list_fieldsList List Fields
bamboohr_employees_list_meta_timezonesList timezones
bamboohr_employees_list_tabular_fieldsList Tabular Fields
bamboohr_employees_list_usersList Users
bamboohr_employees_patch_company_profile_company_informationUpdate company information (phone, address, legal name)
bamboohr_employees_put_company_industry_codesUpdate Company Industry Codes
bamboohr_employees_put_company_profile_display_nameUpdate company display name
bamboohr_employees_update_company_fileUpdate Company File
bamboohr_employees_update_employeeUpdate Employee
bamboohr_employees_update_employee_fileUpdate Employee File
bamboohr_employees_update_list_field_valuesUpdate List Field Values
bamboohr_employees_update_locationUpdate a job location
bamboohr_employees_update_table_rowUpdate Table Row
bamboohr_employees_update_table_row_v1_1Update Table Row v1.1
bamboohr_employees_upload_company_fileUpload Company File
bamboohr_employees_upload_employee_fileUpload Employee File
bamboohr_employees_upload_employee_photoUpload Employee Photo

bamboohr_employees_create_company_file_category

Create Company File Category Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

bamboohr_employees_create_employee

Create Employee Parameters:
ParameterTypeRequiredDefaultDescription
departmentstringNoDepartment name.
firstNamestringYesLegal first name (required).
hireDatestringNoHire date in YYYY-MM-DD format.
jobTitlestringNoJob title.
lastNamestringYesLegal last name (required).
workEmailstringNoWork email address.

bamboohr_employees_create_employee_file_category

Create Employee File Category Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

bamboohr_employees_create_location

Create a job location Parameters:
ParameterTypeRequiredDefaultDescription
addressobjectYesAddress details for the location. When remoteLocation is true, none are required and must be null or omitted
archivedbooleanNoWhether the location is archived
labelstringYesDisplay name for the location

bamboohr_employees_create_table_row

Create Table Row Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID.
tablestringYesThe name of the table to add a row to (e.g., jobInfo, compensation).
datestringNoThe effective date for the row in YYYY-MM-DD format.
departmentstringNoThe department value for the row.
divisionstringNoThe division value for the row.
jobTitlestringNoThe job title value for the row.
locationstringNoThe employee location value for the row.
reportsTostringNoThe manager or reports-to value for the row.
teamsstring[]NoTeam values associated with the row.

bamboohr_employees_create_table_row_v1_1

Create Table Row v1.1 Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID.
tablestringYesThe name of the table to add a row to (e.g., jobInfo, compensation).
datestringNoThe effective date for the row in YYYY-MM-DD format.
departmentstringNoThe department value for the row.
divisionstringNoThe division value for the row.
jobTitlestringNoThe job title value for the row.
locationstringNoThe employee location value for the row.
reportsTostringNoThe manager or reports-to value for the row.
teamsstring[]NoTeam values associated with the row.

bamboohr_employees_delete_company_file

Delete Company File Parameters:
ParameterTypeRequiredDefaultDescription
fileIdintegerYesThe ID of the company file to delete.

bamboohr_employees_delete_employee_file

Delete Employee File Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the employee whose file is being deleted. Use 0 to default to the employee associated with the API key.
fileIdintegerYesThe ID of the employee file to delete.

bamboohr_employees_delete_employee_table_row

Delete Employee Table Row Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID.
tablestringYesThe name of the table containing the row to delete (e.g., jobInfo, compensation, customTabularField).
rowIdstringYesThe ID of the specific row to delete.

bamboohr_employees_delete_location

Delete a job location Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the location to delete

bamboohr_employees_get_changed_employee_ids

Get Changed Employee IDs Parameters:
ParameterTypeRequiredDefaultDescription
sincestringYesISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned.
typestringNoFilter by change type. If omitted, all change types are returned.

bamboohr_employees_get_changed_employee_table_data

Get Changed Employee Table Data Parameters:
ParameterTypeRequiredDefaultDescription
tablestringYesThe name of the table to retrieve changed data for (e.g., jobInfo, compensation).
sincestringYesISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned.

bamboohr_employees_get_company_file

Get Company File Parameters:
ParameterTypeRequiredDefaultDescription
fileIdintegerYesThe ID of the company file to download.

bamboohr_employees_get_company_information

Get Company Information

bamboohr_employees_get_company_profile_integrations

Get Company Profile Integrations

bamboohr_employees_get_countries_options

Get Countries

bamboohr_employees_get_directory

Get Employees Directory Parameters:
ParameterTypeRequiredDefaultDescription
onlyCurrentbooleanNoWhen true (the default), only current employees are returned. Set to false to include future employees that have a hire date or employment status effective date in the future.

bamboohr_employees_get_employee

Get Employee Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any).
fieldsstringNoComma-separated list of field names to include in the response. See the List Fields endpoint for valid field names.
onlyCurrentbooleanNoSetting to false will return future-dated values from history table fields. Defaults to true.

bamboohr_employees_get_employee_file

Get Employee File Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the employee whose file is being retrieved. Use 0 to resolve to the employee associated with the API key.
fileIdintegerYesThe ID of the employee file to download.

bamboohr_employees_get_employee_photo

Get Employee Photo Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee whose photo to retrieve.
sizestringYesThe desired photo size. One of: original, large, medium, small, xs, tiny.
widthintegerNoOptional. Scales the returned image to the specified pixel width, capped at the natural width of the requested size. Only applies to small and tiny sizes.
heightintegerNoOptional. Scales the returned image to the specified pixel height, capped at the natural height of the requested size. Only applies to small and tiny sizes.

bamboohr_employees_get_employee_table_data

Get Employee Table Data Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID. Use the special value “all” to retrieve table data for all employees the API user has access to.
tablestringYesThe name of the table to retrieve (e.g., jobInfo, compensation, employmentStatus).

bamboohr_employees_get_location

Get a job location Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the location
expandstring[]NoComma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country

bamboohr_employees_get_locations

List job locations Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoThe number of items to return per page.
pageintegerNoThe page number to retrieve.
sortstringNoOrdering by OData (Open Data Protocol) v4 specification. Supported fields: label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation, createdAt, archivedAt
selectstringNoProjection (field selection) by OData specification. Supported fields: id, label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation, createdAt, archivedAt
filterstringNoFilter by an OData (Open Data Protocol) v4 specification. Supported fields: id, label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation
expandstring[]NoComma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country

bamboohr_employees_get_states_by_country_id

Get States by Country ID Parameters:
ParameterTypeRequiredDefaultDescription
countryIdintegerYesThe numeric ID of the country whose states or provinces to retrieve. Use the Get Countries endpoint to look up valid country IDs.

bamboohr_employees_list_company_files

Get Company Files and Categories

bamboohr_employees_list_employee_files

List Employee Files Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the employee whose files are being listed.

bamboohr_employees_list_employees

List Employees Parameters:
ParameterTypeRequiredDefaultDescription
filterobjectNoFilters used to match employees. Encode filter properties using deepObject style. If the caller does not have access to the filtered field on a matching employee, that employee is excluded from the results to avoid leaking sensitive data.
sortstringNoComma-separated list of sortable fields. Prefix a field with ”-” for descending order. Allowed fields: employeeId, firstName, lastName, preferredName, jobTitleName, status. Nulls sort first in ascending order and last in descending order. If the caller does not have access to the sort field for an employee, that employee is excluded from the final result set to avoid leaking sensitive information.
fieldsstring[]NoComma-separated list of additional fields to include in the response beyond the default set. Unrecognized field names are silently ignored. Field values are subject to permission checks — restricted fields will be null and their names are listed in _restrictedFields.
pageobjectNoCursor-based pagination parameters (limit, after, before).

bamboohr_employees_list_fields

List Fields

bamboohr_employees_list_list_fields

List List Fields Parameters:
ParameterTypeRequiredDefaultDescription
formatstringNoSet to “json” to receive JSON output as an alternative to using the Accept header.

bamboohr_employees_list_meta_timezones

List timezones Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoThe number of items to return per page.
pageintegerNoThe page number to retrieve.
sortstringNoOrdering by OData (Open Data Protocol) v4 specification
selectstringNoProjection (field selection) by OData specification
filterstringNoFilter by an OData (Open Data Protocol) v4 specification

bamboohr_employees_list_tabular_fields

List Tabular Fields

bamboohr_employees_list_users

List Users Parameters:
ParameterTypeRequiredDefaultDescription
statusstringNoComma-separated list of statuses to filter by. Valid values: enabled, disabled. Defaults to returning users of all statuses when omitted or when no recognized value is provided.

bamboohr_employees_patch_company_profile_company_information

Update company information (phone, address, legal name) Parameters:
ParameterTypeRequiredDefaultDescription
addressobjectNoCompany address. When address is included in the patch (non-null object), city, state, and zip must all be sent as non-empty strings. line1 and line2 are optional (JSON null removes a line per merge-patch).
legalNamestringNoLegal name of the company (name_of_employer). Required (non-empty) when this field is present in the patch.
phonestringNoContact phone number. Required (non-empty) when this field is present in the patch.

bamboohr_employees_put_company_industry_codes

Update Company Industry Codes Parameters:
ParameterTypeRequiredDefaultDescription
industryIdsinteger[]NoList of industry IDs associated with the company. Currently limited to a single entry.

bamboohr_employees_put_company_profile_display_name

Update company display name Parameters:
ParameterTypeRequiredDefaultDescription
companyNamestringNoThe new display name for the company. Must be a non-empty string with a maximum length of 255 characters (character count, not bytes, so multibyte UTF-8 characters are properly supported).

bamboohr_employees_update_company_file

Update Company File Parameters:
ParameterTypeRequiredDefaultDescription
fileIdintegerYesThe ID of the company file to update.
categoryIdstringNoThe ID of the category (file section) to move the file to.
namestringNoThe new display name for the file.
shareWithEmployeestringNoWhether the file is shared with employees.

bamboohr_employees_update_employee

Update Employee Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID.
address1stringNoStreet address line 1.
citystringNoCity.
countrystringNoCountry name.
departmentstringNoDepartment name.
divisionstringNoDivision name.
firstNamestringNoLegal first name.
hireDatestringNoHire date in YYYY-MM-DD format.
homePhonestringNoHome phone number.
jobTitlestringNoJob title.
lastNamestringNoLegal last name.
locationstringNoLocation name.
mobilePhonestringNoMobile phone number.
statestringNoState or province. Values are normalized to standard abbreviations (e.g., “Pennsylvania” becomes “PA”).
workEmailstringNoWork email address.
workPhonestringNoWork phone number.
zipcodestringNoZIP or postal code.

bamboohr_employees_update_employee_file

Update Employee File Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the employee whose file is being updated.
fileIdintegerYesThe ID of the employee file to update.
categoryIdintegerNoThe ID of the file category (section) to move the file into.
namestringNoThe new display name for the file.
shareWithEmployeestringNoWhether the file is shared with the employee. Also accepted as ‘shareWithEmployees’.
shareWithEmployeesstringNoAlias for shareWithEmployee. Whether the file is shared with the employee.

bamboohr_employees_update_list_field_values

Update List Field Values Parameters:
ParameterTypeRequiredDefaultDescription
listFieldIdstringYesThe ID of the list field to update.
optionsobject[]NoThe list field options to create, update, or archive.

bamboohr_employees_update_location

Update a job location Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the location to update
addressobjectNoAddress details for the location. When remoteLocation is true, none are required and must be null or omitted
archivedbooleanNoWhether the location is archived
labelstringNoUpdated display name

bamboohr_employees_update_table_row

Update Table Row Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID.
tablestringYesThe name of the table containing the row to update (e.g., jobInfo, compensation).
rowIdstringYesThe ID of the row to update.
datestringNoThe effective date for the row in YYYY-MM-DD format.
departmentstringNoThe department value for the row.
divisionstringNoThe division value for the row.
jobTitlestringNoThe job title value for the row.
locationstringNoThe employee location value for the row.
reportsTostringNoThe manager or reports-to value for the row.
teamsstring[]NoTeam values associated with the row.

bamboohr_employees_update_table_row_v1_1

Update Table Row v1.1 Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID.
tablestringYesThe name of the table containing the row to update (e.g., jobInfo, compensation).
rowIdstringYesThe ID of the row to update.
datestringNoThe effective date for the row in YYYY-MM-DD format.
departmentstringNoThe department value for the row.
divisionstringNoThe division value for the row.
jobTitlestringNoThe job title value for the row.
locationstringNoThe employee location value for the row.
reportsTostringNoThe manager or reports-to value for the row.
teamsstring[]NoTeam values associated with the row.

bamboohr_employees_upload_company_file

Upload Company File Parameters:
ParameterTypeRequiredDefaultDescription
categoryintegerYesThe ID of the file category (section) to upload the file into.
filestringYesThe file to upload.
fileNamestringYesThe display name for the uploaded file.
sharestringNoWhether to share the file with all employees. Accepted values: yes or no. Defaults to no.

bamboohr_employees_upload_employee_file

Upload Employee File Parameters:
ParameterTypeRequiredDefaultDescription
idstringYes{id} is an employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any).
categoryintegerYesThe ID of the employee file section to upload the file into.
filestringYesThe file to upload.
fileNamestringYesThe display name for the uploaded file.
sharestringNoWhether to share the file with the employee. Accepted values: yes or no. Defaults to no.

bamboohr_employees_upload_employee_photo

Upload Employee Photo Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee whose photo is being uploaded.
filestringYesThe image file to upload as the employee’s photo.