Guides
Signup For Free

BambooHR ATS API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for BambooHR ATS API as part of the ATS category

Add Application Comment

  • ID: create_candidate_note
  • Operation: write
  • Entities:
  • Summary: The 'Add Application Comment' API allows users to add a comment to a specific application in BambooHR's applicant tracking system. The API requires the company domain and application ID as path parameters. The request body must include a 'type' field with the value 'comment' and a 'comment' field containing the text of the comment. The API key owner must have access to ATS settings. A successful request returns a 200 status code with the type and ID of the newly created comment. Possible error responses include 400 for bad request parameters, 401 for unauthorized access, 403 for insufficient permissions, and 404 for a bad request URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Application Details

  • ID: get_application_details
  • Operation: read
  • Entities: application, job, applicant
  • Summary: The Get Application Details API retrieves detailed information about a specific application in the BambooHR system. It requires the companyDomain and applicationId as path parameters. The API key owner must have access to ATS settings. The response includes application details such as applied date, status, rating, resume and cover letter file IDs, and applicant information including email, phone number, address, and education. The job details and hiring lead information are also provided. The API returns various HTTP status codes indicating success, unauthorized access, insufficient permissions, or a bad request URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Applications

  • ID: get_applications
  • Operation: read
  • Entities: application, job, applicant
  • Summary: The Get Applications API retrieves a list of job applications from BambooHR's applicant tracking system. The API requires the 'companyDomain' path parameter to specify the subdomain used to access BambooHR. It supports various optional query parameters for filtering and sorting the results, such as 'page', 'jobId', 'applicationStatusId', 'applicationStatus', 'jobStatusGroups', 'searchString', 'sortBy', 'sortOrder', and 'newSince'. The response includes a list of applications with details such as application ID, applied date, status, rating, applicant information, and job details. The API returns a 200 status code for success, with possible error codes including 400 for bad request parameters, 401 for unauthorized access, and 403 for insufficient permissions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Locations

  • ID: get_company_locations
  • Operation: read
  • Entities: location, company, job opening
  • Summary: The Get Company Locations API retrieves a list of company locations for use in creating a new job opening. The API requires a valid API key with access to ATS settings. The request is made to the endpoint with the companyDomain as a path parameter. The response includes an array of location objects, each containing details such as id, name, city, state, country, zipcode, address lines, and phone number. The API returns a 200 status code on success, while other status codes indicate errors such as unauthorized access or insufficient permissions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Hiring Leads

  • ID: get_hiring_leads
  • Operation: read
  • Entities: company domain, job opening, hiring lead
  • Summary: The Get Hiring Leads API retrieves potential hiring leads for creating a new job opening in BambooHR. The API requires a valid companyDomain path parameter, which is the subdomain used to access BambooHR. The API key owner must have access to ATS settings. The response includes an array of hiring leads, each with an employeeId and preferredFullName. The API returns a 200 status code on success, and error codes 401, 403, or 404 for unauthorized access, insufficient permissions, or bad request URL, respectively.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Summaries

  • ID: get_job_summaries
  • Operation: read
  • Entities: job, location, department
  • Summary: The Get Job Summaries API retrieves a list of job summaries from BambooHR's applicant tracking system. The API requires the 'companyDomain' path parameter, which is the subdomain used to access BambooHR. Optional query parameters include 'statusGroups' to filter positions by status, 'sortBy' to specify a field for sorting, and 'sortOrder' to determine the order of sorting. The response includes job details such as ID, title, posted date, location, department, status, applicant counts, and posting URL. The API key owner must have access to ATS settings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Statuses for a Company

  • ID: get_statuses_for_a_company
  • Operation: read
  • Entities: status, company, user permission
  • Summary: The Get Statuses API retrieves a list of statuses for a company from BambooHR's applicant tracking system. The API requires a valid API key with access to ATS settings. The request is made to the endpoint with the company's subdomain as a path parameter. The response includes an array of status objects, each containing details such as code, description, enabled status, ID, manageability, name, and translated name. The API returns a 200 status code on success, while 401 and 403 indicate unauthorized access or insufficient permissions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Application Comment

  • ID: post_add_application_comment
  • Operation:
  • Entities:
  • Summary: The 'Add Application Comment' API allows users to add a comment to a specific application in BambooHR's applicant tracking system. The API requires the company domain and application ID as path parameters. The request body must include a 'type' field with the value 'comment' and a 'comment' field containing the text of the comment. The API key owner must have access to ATS settings. A successful request returns a 200 status code with the type and ID of the newly created comment. Possible error responses include 400 for bad request parameters, 401 for unauthorized access, 403 for insufficient permissions, and 404 for a bad request URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add New Candidate

  • ID: post_add_new_candidate
  • Operation: write
  • Entities: application, job, candidate
  • Summary: The 'Add New Candidate' API allows users to add a new candidate application to a job opening in BambooHR. The API requires the company domain as a path parameter and various candidate details in the request body, such as first name, last name, and job ID, which are mandatory. Optional details include email, phone number, address, and more. The API returns a success message with the candidate ID upon successful creation. It handles various response codes, including 200 for success, 401 for unauthorized access, 403 for insufficient permissions, 404 for bad request URL, and 422 for unprocessable entity due to validation errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add New Job Opening

  • ID: post_add_new_job_opening
  • Operation: write
  • Entities: job opening, employment type, department
  • Summary: The 'Add New Job Opening' API allows users to create a new job opening in the BambooHR system. The API requires the user to provide a company domain as a path parameter and various details about the job opening in the request body, such as the posting title, job status, hiring lead, employment type, and job description. Optional parameters include department, minimum experience, compensation, job location, and various application questions. The API returns a success message and the ID of the newly created job opening upon successful execution. Possible response codes include 200 for success, 401 for unauthorized access, 403 for insufficient permissions, 404 for a bad request URL, and 422 for unprocessable entity errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Change Applicant's Status

  • ID: post_change_applicant_status
  • Operation: write
  • Entities: application, status, user
  • Summary: The 'Change Applicant's Status' API allows users to change the status of an applicant's application in BambooHR. The API requires the company domain and application ID as path parameters, and a status ID in the request body. The API key owner must have access to ATS settings. A successful request returns a response with the type 'positionApplicantStatus' and the ID of the status. Possible response codes include 200 for success, 400 for bad request parameters, 401 for unauthorized access, 403 for insufficient permissions, and 404 for a bad request URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 7 days ago