/bamboohr-talent | Type: Application | PCID required: Yes
Tools
bamboohr_talent_close_goal
Close Goal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | string | Yes | — | goalId is the goal ID for the specified employee. |
comment | string | No | — | Optional comment to record when closing the goal. |
bamboohr_talent_create_application_comment
Create Job Application Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationId | integer | Yes | — | The ID of the application to add a comment to. |
comment | string | Yes | — | The comment being posted. |
type | string | No | — | The comment type. Defaults to comment if omitted. |
bamboohr_talent_create_candidate
Create Candidate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | string | No | — | The street address of the candidate. |
city | string | No | — | The city of the candidate. |
collegeName | string | No | — | The college or university of the candidate. |
country | string | No | — | The country of the candidate. Accepts country name or ISO code. |
coverLetter | string | No | — | Cover letter file for the candidate. Accepted MIME types: application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plain, application/rtf, image/jpeg, image/gif, image/png, image/tiff, image/bmp. |
dateAvailable | string | No | — | The available start date of the candidate. Format: Y-m-d (e.g. 2024-06-01). |
desiredSalary | string | No | — | The desired salary of the candidate. |
email | string | No | — | The email address of the candidate. Must be a valid email address. |
firstName | string | Yes | — | The first name of the candidate. |
highestEducation | string | No | — | The highest completed education level of the candidate. |
jobId | integer | Yes | — | The id of the job opening for the candidate application. |
lastName | string | Yes | — | The last name of the candidate. |
linkedinUrl | string | No | — | The LinkedIn profile URL of the candidate. Must match https?://(.*\.)?linkedin.com/.... |
phoneNumber | string | No | — | The phone number of the candidate. |
references | string | No | — | A list of references supplied by the candidate. |
referredBy | string | No | — | The person or entity that referred the candidate. |
resume | string | No | — | Resume file for the candidate. Accepted MIME types: application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plain, application/rtf, image/jpeg, image/gif, image/png, image/tiff, image/bmp. |
source | string | No | — | The source of the candidate application, e.g. LinkedIn, Indeed, etc. |
state | string | No | — | The state or province of the candidate. Accepts state name, abbreviation, or ISO code. |
websiteUrl | string | No | — | The personal website, blog, or online portfolio of the candidate. Must be a valid URL. |
zip | string | No | — | The zip code or postal code of the candidate. |
bamboohr_talent_create_employee_training_record
Create Employee Training Record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | integer | Yes | — | The ID of the employee to add a training record to. |
completed | string | Yes | — | Completed is a required field and must be in yyyy-mm-dd format. |
cost | object | No | — | Optional cost for the training record. |
credits | number | No | — | Credits earned for the training. |
hours | number | No | — | Number of hours for the training. |
instructor | string | No | — | Name of the training instructor. |
notes | string | No | — | Optional notes about the training record. |
type | integer | Yes | — | This must be an existing training type ID. |
bamboohr_talent_create_goal
Create Goal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
alignsWithOptionId | integer | No | — | ID of the option this goal aligns with |
completionDate | string | No | — | The date when the goal was completed in YYYY-MM-DD format. Only valid when percentComplete is 100; providing this field with any other percentComplete value will result in an error. |
description | string | No | — | A detailed description of the goal |
dueDate | string | Yes | — | The due date for the goal in YYYY-MM-DD format |
milestones | object[] | No | — | List of milestones for this goal |
percentComplete | integer | No | — | The percentage of completion for the goal (0-100). Defaults to 0 if omitted. |
sharedWithEmployeeIds | integer[] | Yes | — | List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner. |
title | string | Yes | — | The title of the goal |
bamboohr_talent_create_goal_comment
Create Goal Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | string | Yes | — | goalId is the goal ID for the specified employee. |
text | string | Yes | — | The text content of the comment. |
bamboohr_talent_create_job_opening
Create Job Opening Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationQuestionAddress | string | No | — | Whether the job opening application has a standard question for address (true) or not (false) or if entering an address is mandatory (required). |
applicationQuestionCollege | string | No | — | Whether the job opening application has a standard question for college (true) or not (false) or if entering a college is mandatory (required). |
applicationQuestionCoverLetter | string | No | — | Whether the job opening application has a standard question for cover letter (true) or not (false) or if uploading a cover letter is mandatory (required). |
applicationQuestionDateAvailable | string | No | — | Whether the job opening application has a standard question for availability date (true) or not (false) or if entering an availability date is mandatory (required). |
applicationQuestionDesiredSalary | string | No | — | Whether the job opening application has a standard question for desired salary (true) or not (false) or if entering a desired salary is mandatory (required). |
applicationQuestionHighestEducation | string | No | — | Whether the job opening application has a standard question for highest education (true) or not (false) or if entering highest education is mandatory (required). |
applicationQuestionLinkedinUrl | string | No | — | Whether the job opening application has a standard question for LinkedIn profile url (true) or not (false) or if entering a LinkedIn profile url is mandatory (required). |
applicationQuestionReferences | string | No | — | Whether the job opening application has a standard question for references (true) or not (false) or if entering references is mandatory (required). |
applicationQuestionReferredBy | string | No | — | Whether the job opening application has a standard question for referred by (true) or not (false) or if entering referred by is mandatory (required). |
applicationQuestionResume | string | No | — | Whether the job opening application has a standard question for resume (true) or not (false) or if uploading a resume is mandatory (required). |
applicationQuestionWebsiteUrl | string | No | — | Whether the job opening application has a standard question for website url (true) or not (false) or if entering a website url is mandatory (required). |
compensation | string | No | — | The pay rate or compensation for the job opening. |
department | string | No | — | The department of the job opening. |
employmentType | string | Yes | — | The type of employment offered in the job opening, e.g. Full-Time, Part-Time, Contractor, etc. |
hiringLead | integer | Yes | — | The employee id (from the v1/applicant_tracking/hiring_leads endpoint) of the hiring lead for the job opening. |
internalJobCode | string | No | — | The internal job code for the job opening. |
jobDescription | string | Yes | — | The long-form text description of the job opening. |
jobLocation | integer | No | — | The location id (from the v1/applicant_tracking/locations endpoint) of the job opening. Omit this parameter for a remote job location. |
jobStatus | string | Yes | — | The status of the job opening. |
locationType | integer | No | — | The location type for the job opening. 0 = on-site (requires jobLocation), 1 = remote (no jobLocation), 2 = hybrid (requires jobLocation). Defaults to 1 if omitted and no jobLocation is provided, or 0 if jobLocation is provided. |
minimumExperience | string | No | — | The minimum experience level that qualifies a candidate for the job opening. |
postingTitle | string | Yes | — | The posting title of the job opening. |
bamboohr_talent_create_training_category
Create Training Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of the new training category. |
bamboohr_talent_create_training_type
Create Training Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
allowEmployeesToMarkComplete | boolean | No | — | Allows all employees who can view the training to be able to mark it complete. |
category | object | No | — | The category is optional and you can pass either a category id or a category name. |
description | string | No | — | Description for the training. |
dueFromHireDate | integer | No | — | Number of days before the training is due for new hires. Not valid unless training is required. |
frequency | integer | No | — | The frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable. |
linkUrl | string | No | — | Optional URL that can be included with a training. |
name | string | Yes | — | Name of the new training type. |
renewable | boolean | No | — | Renewable is optional but if you are setting it to true you must pass a frequency which is the months between renewals. |
required | boolean | No | — | Is this a required training? |
bamboohr_talent_delete_employee_training_record
Delete Employee Training Record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeTrainingRecordId | integer | Yes | — | The ID of the training record to delete. |
bamboohr_talent_delete_goal
Delete Goal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | string | Yes | — | goalId is the goal ID for the specified employee. |
bamboohr_talent_delete_goal_comment
Delete Goal Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | string | Yes | — | goalId is the goal ID for the specified employee. |
commentId | string | Yes | — | commentId is the ID of a specific comment for the specified goal. |
bamboohr_talent_delete_training_category
Delete Training Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trainingCategoryId | integer | Yes | — | The ID of the training category to delete. |
bamboohr_talent_delete_training_type
Delete Training Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trainingTypeId | integer | Yes | — | The ID of the training type to delete. |
bamboohr_talent_get_alignable_goal_options
Get Alignable Goal Options Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID to get alignable goal options for. |
goalId | integer | No | — | Optional. When provided, the response includes the option currently aligned with this goal. If omitted, returns alignment options for the API user. |
bamboohr_talent_get_application_details
Get Job Application Details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationId | integer | Yes | — | The ID of the application to retrieve details for. |
bamboohr_talent_get_applications
Get Job Applications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | The page number |
jobId | integer | No | — | A Job Id to limit results to |
applicationStatusId | string | No | — | One or more application status IDs to filter by, comma-separated (e.g. 1,2,3). |
applicationStatus | string | No | — | One or more application status group codes to filter by, comma-separated (e.g. NEW,ACTIVE). Allowed values: ALL, ALL_ACTIVE, NEW, ACTIVE, INACTIVE, HIRED. |
jobStatusGroups | string | No | — | One or more position status groups to filter by, comma-separated (e.g. Draft,Open). Allowed values: ALL, DRAFT_AND_OPEN, Open, Filled, Draft, Deleted, On Hold, Canceled. |
searchString | string | No | — | A general search criteria by which to find applications. |
sortBy | string | No | — | A specific field to sort the results by. |
sortOrder | string | No | — | Order by which to sort results. |
newSince | string | No | — | Only return applications submitted after this UTC timestamp. Format: Y-m-d H:i:s (e.g. 2024-01-01 13:00:00). |
bamboohr_talent_get_company_locations
Get Company Locationsbamboohr_talent_get_goal_aggregate
Get Goal Aggregate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | string | Yes | — | goalId is the Goal ID used to generate the aggregate information. |
bamboohr_talent_get_goal_creation_permission
Get Goal Creation Permission Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
bamboohr_talent_get_goals_aggregate_v1_2
Get Goals Aggregate (v1.2) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | integer | Yes | — | employeeId is the employee ID used to generate the aggregate information. |
filter | string | No | — | Filter goals by status. Accepts filter IDs returned by the filters endpoint (e.g. status-inProgress). If omitted or invalid, defaults to the first available filter. The API accepts arbitrary strings and returns 200. |
bamboohr_talent_get_goals_filters_v1_2
Get Goal Filters (v1.2) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | integer | Yes | — | employeeId is the employee ID to whom the goals are assigned. |
bamboohr_talent_get_hiring_leads
Get Hiring Leadsbamboohr_talent_get_job_summaries
Get Job Summaries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
statusGroups | string | No | — | One or more status groups to filter positions by, comma-separated (e.g. Draft,Open). Allowed values: ALL, DRAFT_AND_OPEN, Open, Filled, Draft, Deleted, On Hold, Canceled. Defaults to all non-deleted positions. |
status_ids | string | No | — | One or more specific job opening status IDs to filter by, comma-separated (e.g. 1,2). Combined with statusGroups when both are provided. |
sortBy | string | No | — | A specific field to sort the results by. |
sortOrder | string | No | — | Order by which to sort results. |
bamboohr_talent_get_statuses
Get Applicant Statusesbamboohr_talent_list_employee_trainings
List Employee Training Records Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | integer | Yes | — | The ID of the employee to get a list of trainings for. |
type | integer | No | — | Optional training type ID to filter records. Omitting this parameter returns all training records for the employee. |
bamboohr_talent_list_goal_comments
List Goal Comments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | string | Yes | — | goalId is the goal ID for the specified employee. |
bamboohr_talent_list_goal_share_options
List Goal Sharing Options Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID to get sharing options for. |
search | string | Yes | — | The search term used to filter employees returned. Will search name, employee ID and email. |
limit | integer | No | — | Maximum number of employees to return. Defaults to 10, maximum 100. |
bamboohr_talent_list_goals
List Goals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID to whom the goals are assigned. |
filter | string | No | — | Filter goals by status. If omitted, goals in all statuses except closed are returned. Unrecognized values are treated the same as omitting the parameter. |
bamboohr_talent_list_training_categories
List Training Categoriesbamboohr_talent_list_training_types
List Training Typesbamboohr_talent_reopen_goal
Reopen Goal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | string | Yes | — | goalId is the goal ID for the specified employee. |
bamboohr_talent_update_applicant_status
Update Applicant Status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
applicationId | integer | Yes | — | The ID of the application whose status should be updated. |
status | integer | Yes | — | The ID of the status to assign to the application. Use the Get Applicant Statuses endpoint to get available status IDs. |
bamboohr_talent_update_employee_training_record
Update Employee Training Record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeTrainingRecordId | integer | Yes | — | The ID of the training record to update. |
completed | string | No | — | Completed is the only required field and must be in yyyy-mm-dd format. The other parameters are optional. |
cost | object | No | — | Optional cost for the training record. |
credits | number | No | — | Credits earned for the training. |
hours | number | No | — | Number of hours for the training. |
instructor | string | No | — | Name of the training instructor. |
notes | string | No | — | Optional notes about the training record. |
bamboohr_talent_update_goal_comment
Update Goal Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | string | Yes | — | goalId is the goal ID for the specified employee. |
commentId | string | Yes | — | commentId is the comment ID for the specified goal. |
text | string | No | — | The updated text content of the comment. |
bamboohr_talent_update_goal_milestone_progress
Update Milestone Progress Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID to whom the goals are assigned. |
goalId | string | Yes | — | goalId is the goal ID for the specified employee. |
milestoneId | string | Yes | — | milestoneId is the milestone ID for the specified goal. |
complete | boolean | No | — | Whether the milestone is complete or not |
bamboohr_talent_update_goal_progress
Update Goal Progress Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | integer | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | integer | Yes | — | goalId is the goal ID for the specified employee. |
completionDate | string | No | — | The date when the goal was completed in YYYY-MM-DD format. Required when percentComplete is 100. |
percentComplete | integer | No | — | The percentage of completion for the goal (0-100) |
bamboohr_talent_update_goal_sharing
Update Goal Sharing Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | string | Yes | — | goalId is the goal ID for the specified employee. |
sharedWithEmployeeIds | integer[] | No | — | List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner. |
bamboohr_talent_update_goal_v1_1
Update Goal (v1.1) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | integer | Yes | — | employeeId is the employee ID with whom the goal is associated. |
goalId | integer | Yes | — | goalId is the goal ID for the specified employee. |
alignsWithOptionId | integer | No | — | ID of the option this goal aligns with |
completionDate | string | No | — | The date when the goal was completed in YYYY-MM-DD format. Only valid when percentComplete is 100; providing this field with any other percentComplete value will result in an error. Ignored when milestonesEnabled is true. |
deletedMilestoneIds | integer[] | No | — | List of milestone IDs to be deleted from the goal |
description | string | No | — | A detailed description of the goal |
dueDate | string | No | — | The due date for the goal in YYYY-MM-DD format |
milestones | object[] | No | — | List of milestones to add to this goal |
milestonesEnabled | boolean | No | — | Flag indicating whether milestones are enabled for this goal |
percentComplete | integer | No | — | The percentage of completion for the goal (0-100). Defaults to 0 if omitted. Ignored when milestonesEnabled is true. |
sharedWithEmployeeIds | integer[] | No | — | List of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner. |
title | string | No | — | The title of the goal |
bamboohr_talent_update_training_category
Update Training Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trainingCategoryId | integer | Yes | — | The ID of the training category to update. |
name | string | No | — | Name of the training category. |
bamboohr_talent_update_training_type
Update Training Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trainingTypeId | integer | Yes | — | The ID of the training type to update. |
allowEmployeesToMarkComplete | boolean | No | — | Allows all employees who can view the training to be able to mark it complete. |
category | object | No | — | Category is optional and passing an empty value will remove the category from the training type. Passing a name will assign the training type to the new training category. |
description | string | No | — | Description for the training. |
dueFromHireDate | integer | No | — | Number of days before the training is due for new hires. Not valid unless training is required. |
frequency | integer | No | — | The frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable. |
linkUrl | string | No | — | Optional URL that can be included with a training. |
name | string | No | — | Name of the training type. |
renewable | boolean | No | — | Renewable is optional but if you are setting it to true you must pass a frequency. |
required | boolean | No | — | Is this a required training? |

