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

Tools

ToolDescription
bamboohr_talent_close_goalClose Goal
bamboohr_talent_create_application_commentCreate Job Application Comment
bamboohr_talent_create_candidateCreate Candidate
bamboohr_talent_create_employee_training_recordCreate Employee Training Record
bamboohr_talent_create_goalCreate Goal
bamboohr_talent_create_goal_commentCreate Goal Comment
bamboohr_talent_create_job_openingCreate Job Opening
bamboohr_talent_create_training_categoryCreate Training Category
bamboohr_talent_create_training_typeCreate Training Type
bamboohr_talent_delete_employee_training_recordDelete Employee Training Record
bamboohr_talent_delete_goalDelete Goal
bamboohr_talent_delete_goal_commentDelete Goal Comment
bamboohr_talent_delete_training_categoryDelete Training Category
bamboohr_talent_delete_training_typeDelete Training Type
bamboohr_talent_get_alignable_goal_optionsGet Alignable Goal Options
bamboohr_talent_get_application_detailsGet Job Application Details
bamboohr_talent_get_applicationsGet Job Applications
bamboohr_talent_get_company_locationsGet Company Locations
bamboohr_talent_get_goal_aggregateGet Goal Aggregate
bamboohr_talent_get_goal_creation_permissionGet Goal Creation Permission
bamboohr_talent_get_goals_aggregate_v1_2Get Goals Aggregate (v1.2)
bamboohr_talent_get_goals_filters_v1_2Get Goal Filters (v1.2)
bamboohr_talent_get_hiring_leadsGet Hiring Leads
bamboohr_talent_get_job_summariesGet Job Summaries
bamboohr_talent_get_statusesGet Applicant Statuses
bamboohr_talent_list_employee_trainingsList Employee Training Records
bamboohr_talent_list_goal_commentsList Goal Comments
bamboohr_talent_list_goal_share_optionsList Goal Sharing Options
bamboohr_talent_list_goalsList Goals
bamboohr_talent_list_training_categoriesList Training Categories
bamboohr_talent_list_training_typesList Training Types
bamboohr_talent_reopen_goalReopen Goal
bamboohr_talent_update_applicant_statusUpdate Applicant Status
bamboohr_talent_update_employee_training_recordUpdate Employee Training Record
bamboohr_talent_update_goal_commentUpdate Goal Comment
bamboohr_talent_update_goal_milestone_progressUpdate Milestone Progress
bamboohr_talent_update_goal_progressUpdate Goal Progress
bamboohr_talent_update_goal_sharingUpdate Goal Sharing
bamboohr_talent_update_goal_v1_1Update Goal (v1.1)
bamboohr_talent_update_training_categoryUpdate Training Category
bamboohr_talent_update_training_typeUpdate Training Type

bamboohr_talent_close_goal

Close Goal Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
goalIdstringYesgoalId is the goal ID for the specified employee.
commentstringNoOptional comment to record when closing the goal.

bamboohr_talent_create_application_comment

Create Job Application Comment Parameters:
ParameterTypeRequiredDefaultDescription
applicationIdintegerYesThe ID of the application to add a comment to.
commentstringYesThe comment being posted.
typestringNoThe comment type. Defaults to comment if omitted.

bamboohr_talent_create_candidate

Create Candidate Parameters:
ParameterTypeRequiredDefaultDescription
addressstringNoThe street address of the candidate.
citystringNoThe city of the candidate.
collegeNamestringNoThe college or university of the candidate.
countrystringNoThe country of the candidate. Accepts country name or ISO code.
coverLetterstringNoCover 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.
dateAvailablestringNoThe available start date of the candidate. Format: Y-m-d (e.g. 2024-06-01).
desiredSalarystringNoThe desired salary of the candidate.
emailstringNoThe email address of the candidate. Must be a valid email address.
firstNamestringYesThe first name of the candidate.
highestEducationstringNoThe highest completed education level of the candidate.
jobIdintegerYesThe id of the job opening for the candidate application.
lastNamestringYesThe last name of the candidate.
linkedinUrlstringNoThe LinkedIn profile URL of the candidate. Must match https?://(.*\.)?linkedin.com/....
phoneNumberstringNoThe phone number of the candidate.
referencesstringNoA list of references supplied by the candidate.
referredBystringNoThe person or entity that referred the candidate.
resumestringNoResume 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.
sourcestringNoThe source of the candidate application, e.g. LinkedIn, Indeed, etc.
statestringNoThe state or province of the candidate. Accepts state name, abbreviation, or ISO code.
websiteUrlstringNoThe personal website, blog, or online portfolio of the candidate. Must be a valid URL.
zipstringNoThe zip code or postal code of the candidate.

bamboohr_talent_create_employee_training_record

Create Employee Training Record Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee to add a training record to.
completedstringYesCompleted is a required field and must be in yyyy-mm-dd format.
costobjectNoOptional cost for the training record.
creditsnumberNoCredits earned for the training.
hoursnumberNoNumber of hours for the training.
instructorstringNoName of the training instructor.
notesstringNoOptional notes about the training record.
typeintegerYesThis must be an existing training type ID.

bamboohr_talent_create_goal

Create Goal Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
alignsWithOptionIdintegerNoID of the option this goal aligns with
completionDatestringNoThe 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.
descriptionstringNoA detailed description of the goal
dueDatestringYesThe due date for the goal in YYYY-MM-DD format
milestonesobject[]NoList of milestones for this goal
percentCompleteintegerNoThe percentage of completion for the goal (0-100). Defaults to 0 if omitted.
sharedWithEmployeeIdsinteger[]YesList of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner.
titlestringYesThe title of the goal

bamboohr_talent_create_goal_comment

Create Goal Comment Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
goalIdstringYesgoalId is the goal ID for the specified employee.
textstringYesThe text content of the comment.

bamboohr_talent_create_job_opening

Create Job Opening Parameters:
ParameterTypeRequiredDefaultDescription
applicationQuestionAddressstringNoWhether the job opening application has a standard question for address (true) or not (false) or if entering an address is mandatory (required).
applicationQuestionCollegestringNoWhether the job opening application has a standard question for college (true) or not (false) or if entering a college is mandatory (required).
applicationQuestionCoverLetterstringNoWhether the job opening application has a standard question for cover letter (true) or not (false) or if uploading a cover letter is mandatory (required).
applicationQuestionDateAvailablestringNoWhether the job opening application has a standard question for availability date (true) or not (false) or if entering an availability date is mandatory (required).
applicationQuestionDesiredSalarystringNoWhether the job opening application has a standard question for desired salary (true) or not (false) or if entering a desired salary is mandatory (required).
applicationQuestionHighestEducationstringNoWhether the job opening application has a standard question for highest education (true) or not (false) or if entering highest education is mandatory (required).
applicationQuestionLinkedinUrlstringNoWhether 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).
applicationQuestionReferencesstringNoWhether the job opening application has a standard question for references (true) or not (false) or if entering references is mandatory (required).
applicationQuestionReferredBystringNoWhether the job opening application has a standard question for referred by (true) or not (false) or if entering referred by is mandatory (required).
applicationQuestionResumestringNoWhether the job opening application has a standard question for resume (true) or not (false) or if uploading a resume is mandatory (required).
applicationQuestionWebsiteUrlstringNoWhether the job opening application has a standard question for website url (true) or not (false) or if entering a website url is mandatory (required).
compensationstringNoThe pay rate or compensation for the job opening.
departmentstringNoThe department of the job opening.
employmentTypestringYesThe type of employment offered in the job opening, e.g. Full-Time, Part-Time, Contractor, etc.
hiringLeadintegerYesThe employee id (from the v1/applicant_tracking/hiring_leads endpoint) of the hiring lead for the job opening.
internalJobCodestringNoThe internal job code for the job opening.
jobDescriptionstringYesThe long-form text description of the job opening.
jobLocationintegerNoThe location id (from the v1/applicant_tracking/locations endpoint) of the job opening. Omit this parameter for a remote job location.
jobStatusstringYesThe status of the job opening.
locationTypeintegerNoThe 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.
minimumExperiencestringNoThe minimum experience level that qualifies a candidate for the job opening.
postingTitlestringYesThe posting title of the job opening.

bamboohr_talent_create_training_category

Create Training Category Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesName of the new training category.

bamboohr_talent_create_training_type

Create Training Type Parameters:
ParameterTypeRequiredDefaultDescription
allowEmployeesToMarkCompletebooleanNoAllows all employees who can view the training to be able to mark it complete.
categoryobjectNoThe category is optional and you can pass either a category id or a category name.
descriptionstringNoDescription for the training.
dueFromHireDateintegerNoNumber of days before the training is due for new hires. Not valid unless training is required.
frequencyintegerNoThe frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable.
linkUrlstringNoOptional URL that can be included with a training.
namestringYesName of the new training type.
renewablebooleanNoRenewable is optional but if you are setting it to true you must pass a frequency which is the months between renewals.
requiredbooleanNoIs this a required training?

bamboohr_talent_delete_employee_training_record

Delete Employee Training Record Parameters:
ParameterTypeRequiredDefaultDescription
employeeTrainingRecordIdintegerYesThe ID of the training record to delete.

bamboohr_talent_delete_goal

Delete Goal Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
goalIdstringYesgoalId is the goal ID for the specified employee.

bamboohr_talent_delete_goal_comment

Delete Goal Comment Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
goalIdstringYesgoalId is the goal ID for the specified employee.
commentIdstringYescommentId is the ID of a specific comment for the specified goal.

bamboohr_talent_delete_training_category

Delete Training Category Parameters:
ParameterTypeRequiredDefaultDescription
trainingCategoryIdintegerYesThe ID of the training category to delete.

bamboohr_talent_delete_training_type

Delete Training Type Parameters:
ParameterTypeRequiredDefaultDescription
trainingTypeIdintegerYesThe ID of the training type to delete.

bamboohr_talent_get_alignable_goal_options

Get Alignable Goal Options Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID to get alignable goal options for.
goalIdintegerNoOptional. 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:
ParameterTypeRequiredDefaultDescription
applicationIdintegerYesThe ID of the application to retrieve details for.

bamboohr_talent_get_applications

Get Job Applications Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe page number
jobIdintegerNoA Job Id to limit results to
applicationStatusIdstringNoOne or more application status IDs to filter by, comma-separated (e.g. 1,2,3).
applicationStatusstringNoOne or more application status group codes to filter by, comma-separated (e.g. NEW,ACTIVE). Allowed values: ALL, ALL_ACTIVE, NEW, ACTIVE, INACTIVE, HIRED.
jobStatusGroupsstringNoOne 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.
searchStringstringNoA general search criteria by which to find applications.
sortBystringNoA specific field to sort the results by.
sortOrderstringNoOrder by which to sort results.
newSincestringNoOnly 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 Locations

bamboohr_talent_get_goal_aggregate

Get Goal Aggregate Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
goalIdstringYesgoalId is the Goal ID used to generate the aggregate information.

bamboohr_talent_get_goal_creation_permission

Get Goal Creation Permission Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.

bamboohr_talent_get_goals_aggregate_v1_2

Get Goals Aggregate (v1.2) Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesemployeeId is the employee ID used to generate the aggregate information.
filterstringNoFilter 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:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesemployeeId is the employee ID to whom the goals are assigned.

bamboohr_talent_get_hiring_leads

Get Hiring Leads

bamboohr_talent_get_job_summaries

Get Job Summaries Parameters:
ParameterTypeRequiredDefaultDescription
statusGroupsstringNoOne 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_idsstringNoOne or more specific job opening status IDs to filter by, comma-separated (e.g. 1,2). Combined with statusGroups when both are provided.
sortBystringNoA specific field to sort the results by.
sortOrderstringNoOrder by which to sort results.

bamboohr_talent_get_statuses

Get Applicant Statuses

bamboohr_talent_list_employee_trainings

List Employee Training Records Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee to get a list of trainings for.
typeintegerNoOptional 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:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
goalIdstringYesgoalId is the goal ID for the specified employee.

bamboohr_talent_list_goal_share_options

List Goal Sharing Options Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID to get sharing options for.
searchstringYesThe search term used to filter employees returned. Will search name, employee ID and email.
limitintegerNoMaximum number of employees to return. Defaults to 10, maximum 100.

bamboohr_talent_list_goals

List Goals Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID to whom the goals are assigned.
filterstringNoFilter 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 Categories

bamboohr_talent_list_training_types

List Training Types

bamboohr_talent_reopen_goal

Reopen Goal Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
goalIdstringYesgoalId is the goal ID for the specified employee.

bamboohr_talent_update_applicant_status

Update Applicant Status Parameters:
ParameterTypeRequiredDefaultDescription
applicationIdintegerYesThe ID of the application whose status should be updated.
statusintegerYesThe 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:
ParameterTypeRequiredDefaultDescription
employeeTrainingRecordIdintegerYesThe ID of the training record to update.
completedstringNoCompleted is the only required field and must be in yyyy-mm-dd format. The other parameters are optional.
costobjectNoOptional cost for the training record.
creditsnumberNoCredits earned for the training.
hoursnumberNoNumber of hours for the training.
instructorstringNoName of the training instructor.
notesstringNoOptional notes about the training record.

bamboohr_talent_update_goal_comment

Update Goal Comment Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
goalIdstringYesgoalId is the goal ID for the specified employee.
commentIdstringYescommentId is the comment ID for the specified goal.
textstringNoThe updated text content of the comment.

bamboohr_talent_update_goal_milestone_progress

Update Milestone Progress Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID to whom the goals are assigned.
goalIdstringYesgoalId is the goal ID for the specified employee.
milestoneIdstringYesmilestoneId is the milestone ID for the specified goal.
completebooleanNoWhether the milestone is complete or not

bamboohr_talent_update_goal_progress

Update Goal Progress Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesemployeeId is the employee ID with whom the goal is associated.
goalIdintegerYesgoalId is the goal ID for the specified employee.
completionDatestringNoThe date when the goal was completed in YYYY-MM-DD format. Required when percentComplete is 100.
percentCompleteintegerNoThe percentage of completion for the goal (0-100)

bamboohr_talent_update_goal_sharing

Update Goal Sharing Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesemployeeId is the employee ID with whom the goal is associated.
goalIdstringYesgoalId is the goal ID for the specified employee.
sharedWithEmployeeIdsinteger[]NoList 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:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesemployeeId is the employee ID with whom the goal is associated.
goalIdintegerYesgoalId is the goal ID for the specified employee.
alignsWithOptionIdintegerNoID of the option this goal aligns with
completionDatestringNoThe 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.
deletedMilestoneIdsinteger[]NoList of milestone IDs to be deleted from the goal
descriptionstringNoA detailed description of the goal
dueDatestringNoThe due date for the goal in YYYY-MM-DD format
milestonesobject[]NoList of milestones to add to this goal
milestonesEnabledbooleanNoFlag indicating whether milestones are enabled for this goal
percentCompleteintegerNoThe percentage of completion for the goal (0-100). Defaults to 0 if omitted. Ignored when milestonesEnabled is true.
sharedWithEmployeeIdsinteger[]NoList of employee IDs with whom the goal is shared. Must include the employee ID of the goal owner.
titlestringNoThe title of the goal

bamboohr_talent_update_training_category

Update Training Category Parameters:
ParameterTypeRequiredDefaultDescription
trainingCategoryIdintegerYesThe ID of the training category to update.
namestringNoName of the training category.

bamboohr_talent_update_training_type

Update Training Type Parameters:
ParameterTypeRequiredDefaultDescription
trainingTypeIdintegerYesThe ID of the training type to update.
allowEmployeesToMarkCompletebooleanNoAllows all employees who can view the training to be able to mark it complete.
categoryobjectNoCategory 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.
descriptionstringNoDescription for the training.
dueFromHireDateintegerNoNumber of days before the training is due for new hires. Not valid unless training is required.
frequencyintegerNoThe frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable.
linkUrlstringNoOptional URL that can be included with a training.
namestringNoName of the training type.
renewablebooleanNoRenewable is optional but if you are setting it to true you must pass a frequency.
requiredbooleanNoIs this a required training?