/bamboohr-employees | Type: Application | PCID required: Yes
Tools
bamboohr_employees_create_company_file_category
Create Company File Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
bamboohr_employees_create_employee
Create Employee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
department | string | No | — | Department name. |
firstName | string | Yes | — | Legal first name (required). |
hireDate | string | No | — | Hire date in YYYY-MM-DD format. |
jobTitle | string | No | — | Job title. |
lastName | string | Yes | — | Legal last name (required). |
workEmail | string | No | — | Work email address. |
bamboohr_employees_create_employee_file_category
Create Employee File Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
bamboohr_employees_create_location
Create a job location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | object | Yes | — | Address details for the location. When remoteLocation is true, none are required and must be null or omitted |
archived | boolean | No | — | Whether the location is archived |
label | string | Yes | — | Display name for the location |
bamboohr_employees_create_table_row
Create Table Row Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. |
table | string | Yes | — | The name of the table to add a row to (e.g., jobInfo, compensation). |
date | string | No | — | The effective date for the row in YYYY-MM-DD format. |
department | string | No | — | The department value for the row. |
division | string | No | — | The division value for the row. |
jobTitle | string | No | — | The job title value for the row. |
location | string | No | — | The employee location value for the row. |
reportsTo | string | No | — | The manager or reports-to value for the row. |
teams | string[] | No | — | Team values associated with the row. |
bamboohr_employees_create_table_row_v1_1
Create Table Row v1.1 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. |
table | string | Yes | — | The name of the table to add a row to (e.g., jobInfo, compensation). |
date | string | No | — | The effective date for the row in YYYY-MM-DD format. |
department | string | No | — | The department value for the row. |
division | string | No | — | The division value for the row. |
jobTitle | string | No | — | The job title value for the row. |
location | string | No | — | The employee location value for the row. |
reportsTo | string | No | — | The manager or reports-to value for the row. |
teams | string[] | No | — | Team values associated with the row. |
bamboohr_employees_delete_company_file
Delete Company File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | integer | Yes | — | The ID of the company file to delete. |
bamboohr_employees_delete_employee_file
Delete Employee File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the employee whose file is being deleted. Use 0 to default to the employee associated with the API key. |
fileId | integer | Yes | — | The ID of the employee file to delete. |
bamboohr_employees_delete_employee_table_row
Delete Employee Table Row Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. |
table | string | Yes | — | The name of the table containing the row to delete (e.g., jobInfo, compensation, customTabularField). |
rowId | string | Yes | — | The ID of the specific row to delete. |
bamboohr_employees_delete_location
Delete a job location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the location to delete |
bamboohr_employees_get_changed_employee_ids
Get Changed Employee IDs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
since | string | Yes | — | ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned. |
type | string | No | — | Filter by change type. If omitted, all change types are returned. |
bamboohr_employees_get_changed_employee_table_data
Get Changed Employee Table Data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
table | string | Yes | — | The name of the table to retrieve changed data for (e.g., jobInfo, compensation). |
since | string | Yes | — | ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned. |
bamboohr_employees_get_company_file
Get Company File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | integer | Yes | — | The ID of the company file to download. |
bamboohr_employees_get_company_information
Get Company Informationbamboohr_employees_get_company_profile_integrations
Get Company Profile Integrationsbamboohr_employees_get_countries_options
Get Countriesbamboohr_employees_get_directory
Get Employees Directory Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
onlyCurrent | boolean | No | — | When 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any). |
fields | string | No | — | Comma-separated list of field names to include in the response. See the List Fields endpoint for valid field names. |
onlyCurrent | boolean | No | — | Setting to false will return future-dated values from history table fields. Defaults to true. |
bamboohr_employees_get_employee_file
Get Employee File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the employee whose file is being retrieved. Use 0 to resolve to the employee associated with the API key. |
fileId | integer | Yes | — | The ID of the employee file to download. |
bamboohr_employees_get_employee_photo
Get Employee Photo Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | integer | Yes | — | The ID of the employee whose photo to retrieve. |
size | string | Yes | — | The desired photo size. One of: original, large, medium, small, xs, tiny. |
width | integer | No | — | Optional. 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. |
height | integer | No | — | Optional. 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. Use the special value “all” to retrieve table data for all employees the API user has access to. |
table | string | Yes | — | The name of the table to retrieve (e.g., jobInfo, compensation, employmentStatus). |
bamboohr_employees_get_location
Get a job location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the location |
expand | string[] | No | — | Comma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country |
bamboohr_employees_get_locations
List job locations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | The number of items to return per page. |
page | integer | No | — | The page number to retrieve. |
sort | string | No | — | Ordering 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 |
select | string | No | — | Projection (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 |
filter | string | No | — | Filter 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 |
expand | string[] | No | — | Comma-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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
countryId | integer | Yes | — | The 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 Categoriesbamboohr_employees_list_employee_files
List Employee Files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the employee whose files are being listed. |
bamboohr_employees_list_employees
List Employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | object | No | — | Filters 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. |
sort | string | No | — | Comma-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. |
fields | string[] | No | — | Comma-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. |
page | object | No | — | Cursor-based pagination parameters (limit, after, before). |
bamboohr_employees_list_fields
List Fieldsbamboohr_employees_list_list_fields
List List Fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
format | string | No | — | Set to “json” to receive JSON output as an alternative to using the Accept header. |
bamboohr_employees_list_meta_timezones
List timezones Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | The number of items to return per page. |
page | integer | No | — | The page number to retrieve. |
sort | string | No | — | Ordering by OData (Open Data Protocol) v4 specification |
select | string | No | — | Projection (field selection) by OData specification |
filter | string | No | — | Filter by an OData (Open Data Protocol) v4 specification |
bamboohr_employees_list_tabular_fields
List Tabular Fieldsbamboohr_employees_list_users
List Users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | Comma-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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | object | No | — | Company 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). |
legalName | string | No | — | Legal name of the company (name_of_employer). Required (non-empty) when this field is present in the patch. |
phone | string | No | — | Contact phone number. Required (non-empty) when this field is present in the patch. |
bamboohr_employees_put_company_industry_codes
Update Company Industry Codes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
industryIds | integer[] | No | — | List 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
companyName | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fileId | integer | Yes | — | The ID of the company file to update. |
categoryId | string | No | — | The ID of the category (file section) to move the file to. |
name | string | No | — | The new display name for the file. |
shareWithEmployee | string | No | — | Whether the file is shared with employees. |
bamboohr_employees_update_employee
Update Employee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. |
address1 | string | No | — | Street address line 1. |
city | string | No | — | City. |
country | string | No | — | Country name. |
department | string | No | — | Department name. |
division | string | No | — | Division name. |
firstName | string | No | — | Legal first name. |
hireDate | string | No | — | Hire date in YYYY-MM-DD format. |
homePhone | string | No | — | Home phone number. |
jobTitle | string | No | — | Job title. |
lastName | string | No | — | Legal last name. |
location | string | No | — | Location name. |
mobilePhone | string | No | — | Mobile phone number. |
state | string | No | — | State or province. Values are normalized to standard abbreviations (e.g., “Pennsylvania” becomes “PA”). |
workEmail | string | No | — | Work email address. |
workPhone | string | No | — | Work phone number. |
zipcode | string | No | — | ZIP or postal code. |
bamboohr_employees_update_employee_file
Update Employee File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the employee whose file is being updated. |
fileId | integer | Yes | — | The ID of the employee file to update. |
categoryId | integer | No | — | The ID of the file category (section) to move the file into. |
name | string | No | — | The new display name for the file. |
shareWithEmployee | string | No | — | Whether the file is shared with the employee. Also accepted as ‘shareWithEmployees’. |
shareWithEmployees | string | No | — | Alias for shareWithEmployee. Whether the file is shared with the employee. |
bamboohr_employees_update_list_field_values
Update List Field Values Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
listFieldId | string | Yes | — | The ID of the list field to update. |
options | object[] | No | — | The list field options to create, update, or archive. |
bamboohr_employees_update_location
Update a job location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the location to update |
address | object | No | — | Address details for the location. When remoteLocation is true, none are required and must be null or omitted |
archived | boolean | No | — | Whether the location is archived |
label | string | No | — | Updated display name |
bamboohr_employees_update_table_row
Update Table Row Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. |
table | string | Yes | — | The name of the table containing the row to update (e.g., jobInfo, compensation). |
rowId | string | Yes | — | The ID of the row to update. |
date | string | No | — | The effective date for the row in YYYY-MM-DD format. |
department | string | No | — | The department value for the row. |
division | string | No | — | The division value for the row. |
jobTitle | string | No | — | The job title value for the row. |
location | string | No | — | The employee location value for the row. |
reportsTo | string | No | — | The manager or reports-to value for the row. |
teams | string[] | No | — | Team values associated with the row. |
bamboohr_employees_update_table_row_v1_1
Update Table Row v1.1 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. |
table | string | Yes | — | The name of the table containing the row to update (e.g., jobInfo, compensation). |
rowId | string | Yes | — | The ID of the row to update. |
date | string | No | — | The effective date for the row in YYYY-MM-DD format. |
department | string | No | — | The department value for the row. |
division | string | No | — | The division value for the row. |
jobTitle | string | No | — | The job title value for the row. |
location | string | No | — | The employee location value for the row. |
reportsTo | string | No | — | The manager or reports-to value for the row. |
teams | string[] | No | — | Team values associated with the row. |
bamboohr_employees_upload_company_file
Upload Company File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category | integer | Yes | — | The ID of the file category (section) to upload the file into. |
file | string | Yes | — | The file to upload. |
fileName | string | Yes | — | The display name for the uploaded file. |
share | string | No | — | Whether to share the file with all employees. Accepted values: yes or no. Defaults to no. |
bamboohr_employees_upload_employee_file
Upload Employee File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | {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). |
category | integer | Yes | — | The ID of the employee file section to upload the file into. |
file | string | Yes | — | The file to upload. |
fileName | string | Yes | — | The display name for the uploaded file. |
share | string | No | — | Whether to share the file with the employee. Accepted values: yes or no. Defaults to no. |
bamboohr_employees_upload_employee_photo
Upload Employee Photo Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | integer | Yes | — | The ID of the employee whose photo is being uploaded. |
file | string | Yes | — | The image file to upload as the employee’s photo. |

