> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # bamboohr-employees > BambooHR Employees - manage employees, files, company profile, locations, and tabular data **Server path:** `/bamboohr-employees` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | | [`bamboohr_employees_create_company_file_category`](#bamboohr_employees_create_company_file_category) | Create Company File Category | | [`bamboohr_employees_create_employee`](#bamboohr_employees_create_employee) | Create Employee | | [`bamboohr_employees_create_employee_file_category`](#bamboohr_employees_create_employee_file_category) | Create Employee File Category | | [`bamboohr_employees_create_location`](#bamboohr_employees_create_location) | Create a job location | | [`bamboohr_employees_create_table_row`](#bamboohr_employees_create_table_row) | Create Table Row | | [`bamboohr_employees_create_table_row_v1_1`](#bamboohr_employees_create_table_row_v1_1) | Create Table Row v1.1 | | [`bamboohr_employees_delete_company_file`](#bamboohr_employees_delete_company_file) | Delete Company File | | [`bamboohr_employees_delete_employee_file`](#bamboohr_employees_delete_employee_file) | Delete Employee File | | [`bamboohr_employees_delete_employee_table_row`](#bamboohr_employees_delete_employee_table_row) | Delete Employee Table Row | | [`bamboohr_employees_delete_location`](#bamboohr_employees_delete_location) | Delete a job location | | [`bamboohr_employees_get_changed_employee_ids`](#bamboohr_employees_get_changed_employee_ids) | Get Changed Employee IDs | | [`bamboohr_employees_get_changed_employee_table_data`](#bamboohr_employees_get_changed_employee_table_data) | Get Changed Employee Table Data | | [`bamboohr_employees_get_company_file`](#bamboohr_employees_get_company_file) | Get Company File | | [`bamboohr_employees_get_company_information`](#bamboohr_employees_get_company_information) | Get Company Information | | [`bamboohr_employees_get_company_profile_integrations`](#bamboohr_employees_get_company_profile_integrations) | Get Company Profile Integrations | | [`bamboohr_employees_get_countries_options`](#bamboohr_employees_get_countries_options) | Get Countries | | [`bamboohr_employees_get_directory`](#bamboohr_employees_get_directory) | Get Employees Directory | | [`bamboohr_employees_get_employee`](#bamboohr_employees_get_employee) | Get Employee | | [`bamboohr_employees_get_employee_file`](#bamboohr_employees_get_employee_file) | Get Employee File | | [`bamboohr_employees_get_employee_photo`](#bamboohr_employees_get_employee_photo) | Get Employee Photo | | [`bamboohr_employees_get_employee_table_data`](#bamboohr_employees_get_employee_table_data) | Get Employee Table Data | | [`bamboohr_employees_get_location`](#bamboohr_employees_get_location) | Get a job location | | [`bamboohr_employees_get_locations`](#bamboohr_employees_get_locations) | List job locations | | [`bamboohr_employees_get_states_by_country_id`](#bamboohr_employees_get_states_by_country_id) | Get States by Country ID | | [`bamboohr_employees_list_company_files`](#bamboohr_employees_list_company_files) | Get Company Files and Categories | | [`bamboohr_employees_list_employee_files`](#bamboohr_employees_list_employee_files) | List Employee Files | | [`bamboohr_employees_list_employees`](#bamboohr_employees_list_employees) | List Employees | | [`bamboohr_employees_list_fields`](#bamboohr_employees_list_fields) | List Fields | | [`bamboohr_employees_list_list_fields`](#bamboohr_employees_list_list_fields) | List List Fields | | [`bamboohr_employees_list_meta_timezones`](#bamboohr_employees_list_meta_timezones) | List timezones | | [`bamboohr_employees_list_tabular_fields`](#bamboohr_employees_list_tabular_fields) | List Tabular Fields | | [`bamboohr_employees_list_users`](#bamboohr_employees_list_users) | List Users | | [`bamboohr_employees_patch_company_profile_company_information`](#bamboohr_employees_patch_company_profile_company_information) | Update company information (phone, address, legal name) | | [`bamboohr_employees_put_company_industry_codes`](#bamboohr_employees_put_company_industry_codes) | Update Company Industry Codes | | [`bamboohr_employees_put_company_profile_display_name`](#bamboohr_employees_put_company_profile_display_name) | Update company display name | | [`bamboohr_employees_update_company_file`](#bamboohr_employees_update_company_file) | Update Company File | | [`bamboohr_employees_update_employee`](#bamboohr_employees_update_employee) | Update Employee | | [`bamboohr_employees_update_employee_file`](#bamboohr_employees_update_employee_file) | Update Employee File | | [`bamboohr_employees_update_list_field_values`](#bamboohr_employees_update_list_field_values) | Update List Field Values | | [`bamboohr_employees_update_location`](#bamboohr_employees_update_location) | Update a job location | | [`bamboohr_employees_update_table_row`](#bamboohr_employees_update_table_row) | Update Table Row | | [`bamboohr_employees_update_table_row_v1_1`](#bamboohr_employees_update_table_row_v1_1) | Update Table Row v1.1 | | [`bamboohr_employees_upload_company_file`](#bamboohr_employees_upload_company_file) | Upload Company File | | [`bamboohr_employees_upload_employee_file`](#bamboohr_employees_upload_employee_file) | Upload Employee File | | [`bamboohr_employees_upload_employee_photo`](#bamboohr_employees_upload_employee_photo) | Upload Employee Photo | *** ## bamboohr\_employees\_create\_company\_file\_category Create Company File Category **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------ | | `body` | string\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "string" }, "description": "Request body" } }, "required": [ "PCID", "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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "department": { "type": "string", "description": "Department name." }, "firstName": { "type": "string", "description": "Legal first name (required)." }, "hireDate": { "type": "string", "description": "Hire date in YYYY-MM-DD format." }, "jobTitle": { "type": "string", "description": "Job title." }, "lastName": { "type": "string", "description": "Legal last name (required)." }, "workEmail": { "type": "string", "description": "Work email address." } }, "required": [ "PCID", "firstName", "lastName" ] } ``` *** ## bamboohr\_employees\_create\_employee\_file\_category Create Employee File Category **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------ | | `body` | string\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "string" }, "description": "Request body" } }, "required": [ "PCID", "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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address": { "type": "object", "description": "Address details for the location. When remoteLocation is true, none are required and must be null or omitted", "properties": { "address1": { "type": "string", "description": "The address1 value" }, "address2": { "type": "string", "description": "The address2 value" }, "city": { "type": "string", "description": "The city value" }, "stateId": { "type": "string", "description": "State Id" }, "zipcode": { "type": "string", "description": "The zipcode value" }, "countryId": { "type": "string", "description": "Country Id" }, "timezone": { "type": "string", "description": "The utcName value from the /api/v1/meta/timezones endpoint" }, "remoteLocation": { "type": "boolean", "description": "Remote Location" } }, "required": [ "remoteLocation" ] }, "archived": { "type": "boolean", "description": "Whether the location is archived" }, "label": { "type": "string", "description": "Display name for the location" } }, "required": [ "PCID", "address", "label" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table to add a row to (e.g., jobInfo, compensation)." }, "date": { "type": "string", "description": "The effective date for the row in YYYY-MM-DD format." }, "department": { "type": "string", "description": "The department value for the row." }, "division": { "type": "string", "description": "The division value for the row." }, "jobTitle": { "type": "string", "description": "The job title value for the row." }, "location": { "type": "string", "description": "The employee location value for the row." }, "reportsTo": { "type": "string", "description": "The manager or reports-to value for the row." }, "teams": { "type": "array", "items": { "type": "string" }, "description": "Team values associated with the row." } }, "required": [ "PCID", "id", "table" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table to add a row to (e.g., jobInfo, compensation)." }, "date": { "type": "string", "description": "The effective date for the row in YYYY-MM-DD format." }, "department": { "type": "string", "description": "The department value for the row." }, "division": { "type": "string", "description": "The division value for the row." }, "jobTitle": { "type": "string", "description": "The job title value for the row." }, "location": { "type": "string", "description": "The employee location value for the row." }, "reportsTo": { "type": "string", "description": "The manager or reports-to value for the row." }, "teams": { "type": "array", "items": { "type": "string" }, "description": "Team values associated with the row." } }, "required": [ "PCID", "id", "table" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fileId": { "type": "integer", "description": "The ID of the company file to delete." } }, "required": [ "PCID", "fileId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the employee whose file is being deleted. Use 0 to default to the employee associated with the API key." }, "fileId": { "type": "integer", "description": "The ID of the employee file to delete." } }, "required": [ "PCID", "id", "fileId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table containing the row to delete (e.g., jobInfo, compensation, customTabularField)." }, "rowId": { "type": "string", "description": "The ID of the specific row to delete." } }, "required": [ "PCID", "id", "table", "rowId" ] } ``` *** ## bamboohr\_employees\_delete\_location Delete a job location **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------- | | `id` | string | Yes | — | The ID of the location to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the location to delete" } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "since": { "type": "string", "description": "ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned." }, "type": { "type": "string", "description": "Filter by change type. If omitted, all change types are returned.", "enum": [ "inserted", "updated", "deleted", "all" ] } }, "required": [ "PCID", "since" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "table": { "type": "string", "description": "The name of the table to retrieve changed data for (e.g., jobInfo, compensation)." }, "since": { "type": "string", "description": "ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned." } }, "required": [ "PCID", "table", "since" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fileId": { "type": "integer", "description": "The ID of the company file to download." } }, "required": [ "PCID", "fileId" ] } ``` *** ## bamboohr\_employees\_get\_company\_information Get Company Information ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_get\_company\_profile\_integrations Get Company Profile Integrations ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_get\_countries\_options Get Countries ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_get\_directory Get Employees Directory **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "onlyCurrent": { "type": "boolean", "description": "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." } }, "required": [ "PCID" ] } ``` *** ## 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. | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any)." }, "fields": { "type": "string", "description": "Comma-separated list of field names to include in the response. See the List Fields endpoint for valid field names." }, "onlyCurrent": { "type": "boolean", "description": "Setting to false will return future-dated values from history table fields. Defaults to true." }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the employee whose file is being retrieved. Use 0 to resolve to the employee associated with the API key." }, "fileId": { "type": "integer", "description": "The ID of the employee file to download." } }, "required": [ "PCID", "id", "fileId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee whose photo to retrieve." }, "size": { "type": "string", "description": "The desired photo size. One of: `original`, `large`, `medium`, `small`, `xs`, `tiny`.", "enum": [ "original", "large", "medium", "small", "xs", "tiny" ] }, "width": { "type": "integer", "description": "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": { "type": "integer", "description": "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." } }, "required": [ "PCID", "employeeId", "size" ] } ``` *** ## 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). | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID. Use the special value \"all\" to retrieve table data for all employees the API user has access to." }, "table": { "type": "string", "description": "The name of the table to retrieve (e.g., jobInfo, compensation, employmentStatus)." }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID", "id", "table" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the location" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "state", "country" ] }, "description": "Comma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "The number of items to return per page." }, "page": { "type": "integer", "description": "The page number to retrieve." }, "sort": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "array", "items": { "type": "string", "enum": [ "state", "country" ] }, "description": "Comma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country" } }, "required": [ "PCID" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "countryId": { "type": "integer", "description": "The numeric ID of the country whose states or provinces to retrieve. Use the Get Countries endpoint to look up valid country IDs." } }, "required": [ "PCID", "countryId" ] } ``` *** ## bamboohr\_employees\_list\_company\_files Get Company Files and Categories ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_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. | | `Accept` | string | No | — | Set to `application/json` to receive a JSON response. Any other value (or omitted) returns XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the employee whose files are being listed." }, "Accept": { "type": "string", "description": "Set to `application/json` to receive a JSON response. Any other value (or omitted) returns XML." } }, "required": [ "PCID", "id" ] } ``` *** ## 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`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter": { "type": "object", "description": "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.", "properties": { "firstName": { "type": "string", "description": "This will match any employees whose first name contains this string (case insensitive)" }, "lastName": { "type": "string", "description": "This will match any employees whose last name contains this string (case insensitive)" }, "jobTitleName": { "type": "string", "description": "This will match any employees whose current job title descriptor contains this string (case insensitive)" }, "status": { "type": "string", "description": "Employee status", "enum": [ "active", "inactive" ] }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "List of employee IDs for batch fetch. Documented form: repeated keys (`filter[ids][]=123&filter[ids][]=124`). For backward compatibility, the endpoint also accepts a single comma-separated string (`filter[ids]=123,124`)." } } }, "sort": { "type": "string", "description": "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": { "type": "array", "items": { "type": "string", "enum": [ "workEmail", "homeEmail", "bestEmail", "middleName", "workPhone", "workPhoneExtension", "mobilePhone", "homePhone", "skypeUsername", "linkedinUrl", "facebookUrl", "instagramUrl", "twitterUrl", "pinterestUrl", "birthDate", "hireDate", "divisionName", "divisionId", "departmentName", "departmentId", "locationName", "locationId", "jobTitleId", "employmentStatusName", "employmentStatusId", "reportsToName", "reportsToId" ] }, "description": "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": { "type": "object", "description": "Cursor-based pagination parameters (`limit`, `after`, `before`)." } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_list\_fields List Fields **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------ | -------- | ------- | --------------------------------------------- | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_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. | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "format": { "type": "string", "description": "Set to \"json\" to receive JSON output as an alternative to using the Accept header.", "enum": [ "json" ] }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "The number of items to return per page." }, "page": { "type": "integer", "description": "The page number to retrieve." }, "sort": { "type": "string", "description": "Ordering by OData (Open Data Protocol) v4 specification" }, "select": { "type": "string", "description": "Projection (field selection) by OData specification" }, "filter": { "type": "string", "description": "Filter by an OData (Open Data Protocol) v4 specification" } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_list\_tabular\_fields List Tabular Fields **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------ | -------- | ------- | --------------------------------------------- | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] } }, "required": [ "PCID" ] } ``` *** ## bamboohr\_employees\_list\_users List Users **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AcceptHeaderParameter` | string | No | — | This endpoint can produce either JSON or XML. | | `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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "AcceptHeaderParameter": { "type": "string", "description": "This endpoint can produce either JSON or XML.", "enum": [ "application/xml", "application/json" ] }, "status": { "type": "string", "description": "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." } }, "required": [ "PCID" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address": { "type": "object", "description": "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).", "properties": { "line1": { "type": "string", "description": "Street address line 1 (employerAddress). Optional; JSON null removes the value per merge-patch semantics." }, "line2": { "type": "string", "description": "Street address line 2 (employerAddress). Optional; JSON null removes the value per merge-patch semantics." }, "city": { "type": "string", "description": "City. Required (non-empty) when address is patched." }, "state": { "type": "string", "description": "State. Required (non-empty) when address is patched." }, "zip": { "type": "string", "description": "Zip or postal code. Required (non-empty) when address is patched." } } }, "legalName": { "type": "string", "description": "Legal name of the company (name_of_employer). Required (non-empty) when this field is present in the patch." }, "phone": { "type": "string", "description": "Contact phone number. Required (non-empty) when this field is present in the patch." } }, "required": [ "PCID" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "industryIds": { "type": "array", "items": { "type": "integer" }, "description": "List of industry IDs associated with the company. Currently limited to a single entry." } }, "required": [ "PCID" ] } ``` *** ## 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). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyName": { "type": "string", "description": "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)." } }, "required": [ "PCID" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fileId": { "type": "integer", "description": "The ID of the company file to update." }, "categoryId": { "type": "string", "description": "The ID of the category (file section) to move the file to." }, "name": { "type": "string", "description": "The new display name for the file." }, "shareWithEmployee": { "type": "string", "description": "Whether the file is shared with employees.", "enum": [ "yes", "no" ] } }, "required": [ "PCID", "fileId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "address1": { "type": "string", "description": "Street address line 1." }, "city": { "type": "string", "description": "City." }, "country": { "type": "string", "description": "Country name." }, "department": { "type": "string", "description": "Department name." }, "division": { "type": "string", "description": "Division name." }, "firstName": { "type": "string", "description": "Legal first name." }, "hireDate": { "type": "string", "description": "Hire date in YYYY-MM-DD format." }, "homePhone": { "type": "string", "description": "Home phone number." }, "jobTitle": { "type": "string", "description": "Job title." }, "lastName": { "type": "string", "description": "Legal last name." }, "location": { "type": "string", "description": "Location name." }, "mobilePhone": { "type": "string", "description": "Mobile phone number." }, "state": { "type": "string", "description": "State or province. Values are normalized to standard abbreviations (e.g., \"Pennsylvania\" becomes \"PA\")." }, "workEmail": { "type": "string", "description": "Work email address." }, "workPhone": { "type": "string", "description": "Work phone number." }, "zipcode": { "type": "string", "description": "ZIP or postal code." } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the employee whose file is being updated." }, "fileId": { "type": "integer", "description": "The ID of the employee file to update." }, "categoryId": { "type": "integer", "description": "The ID of the file category (section) to move the file into." }, "name": { "type": "string", "description": "The new display name for the file." }, "shareWithEmployee": { "type": "string", "description": "Whether the file is shared with the employee. Also accepted as 'shareWithEmployees'.", "enum": [ "yes", "no" ] }, "shareWithEmployees": { "type": "string", "description": "Alias for shareWithEmployee. Whether the file is shared with the employee.", "enum": [ "yes", "no" ] } }, "required": [ "PCID", "id", "fileId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listFieldId": { "type": "string", "description": "The ID of the list field to update." }, "options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The existing option ID. Omit this field to create a new option." }, "value": { "type": "string", "description": "The display value for the option." }, "archived": { "type": "string", "enum": [ "yes", "no" ], "description": "Whether the option should be archived. Use `yes` to archive an option or `no` to keep it active." }, "adpCode": { "type": "string", "description": "Optional payroll-mapping code associated with the option." } } }, "description": "The list field options to create, update, or archive." } }, "required": [ "PCID", "listFieldId" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the location to update" }, "address": { "type": "object", "description": "Address details for the location. When remoteLocation is true, none are required and must be null or omitted", "properties": { "address1": { "type": "string", "description": "The address1 value" }, "address2": { "type": "string", "description": "The address2 value" }, "city": { "type": "string", "description": "The city value" }, "stateId": { "type": "string", "description": "State Id" }, "zipcode": { "type": "string", "description": "The zipcode value" }, "countryId": { "type": "string", "description": "Country Id" }, "timezone": { "type": "string", "description": "The utcName value from the /api/v1/meta/timezones endpoint" }, "remoteLocation": { "type": "boolean", "description": "Remote Location" } }, "required": [ "remoteLocation" ] }, "archived": { "type": "boolean", "description": "Whether the location is archived" }, "label": { "type": "string", "description": "Updated display name" } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table containing the row to update (e.g., jobInfo, compensation)." }, "rowId": { "type": "string", "description": "The ID of the row to update." }, "date": { "type": "string", "description": "The effective date for the row in YYYY-MM-DD format." }, "department": { "type": "string", "description": "The department value for the row." }, "division": { "type": "string", "description": "The division value for the row." }, "jobTitle": { "type": "string", "description": "The job title value for the row." }, "location": { "type": "string", "description": "The employee location value for the row." }, "reportsTo": { "type": "string", "description": "The manager or reports-to value for the row." }, "teams": { "type": "array", "items": { "type": "string" }, "description": "Team values associated with the row." } }, "required": [ "PCID", "id", "table", "rowId" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The employee ID." }, "table": { "type": "string", "description": "The name of the table containing the row to update (e.g., jobInfo, compensation)." }, "rowId": { "type": "string", "description": "The ID of the row to update." }, "date": { "type": "string", "description": "The effective date for the row in YYYY-MM-DD format." }, "department": { "type": "string", "description": "The department value for the row." }, "division": { "type": "string", "description": "The division value for the row." }, "jobTitle": { "type": "string", "description": "The job title value for the row." }, "location": { "type": "string", "description": "The employee location value for the row." }, "reportsTo": { "type": "string", "description": "The manager or reports-to value for the row." }, "teams": { "type": "array", "items": { "type": "string" }, "description": "Team values associated with the row." } }, "required": [ "PCID", "id", "table", "rowId" ] } ``` *** ## 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`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category": { "type": "integer", "description": "The ID of the file category (section) to upload the file into." }, "file": { "type": "string", "description": "The file to upload." }, "fileName": { "type": "string", "description": "The display name for the uploaded file." }, "share": { "type": "string", "description": "Whether to share the file with all employees. Accepted values: `yes` or `no`. Defaults to `no`.", "enum": [ "yes", "no" ] } }, "required": [ "PCID", "category", "file", "fileName" ] } ``` *** ## 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`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "{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": { "type": "integer", "description": "The ID of the employee file section to upload the file into." }, "file": { "type": "string", "description": "The file to upload." }, "fileName": { "type": "string", "description": "The display name for the uploaded file." }, "share": { "type": "string", "description": "Whether to share the file with the employee. Accepted values: `yes` or `no`. Defaults to `no`.", "enum": [ "yes", "no" ] } }, "required": [ "PCID", "id", "category", "file", "fileName" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "integer", "description": "The ID of the employee whose photo is being uploaded." }, "file": { "type": "string", "description": "The image file to upload as the employee's photo." } }, "required": [ "PCID", "employeeId", "file" ] } ```