Bullhorn API Integration

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

Retrieve All Documents Linked to a Candidate Application

ID: get_file_attachments
Operation: read
Entities:
Summary: This API retrieves all documents linked to a candidate application using the GET method. The endpoint requires a candidateId as a path parameter to identify the candidate. An optional BhRestToken can be provided in the headers or query parameters to maintain the session. The response includes a list of file attachments with details such as id, content type, date added, description, file size, and more. Each file attachment is represented with attributes like name, type, and uuid, among others.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_job_application_details
Operation: read
Entities: application
Summary: This API retrieves details of a specific job application using the GET method. The request requires the unique identifier of the JobSubmission and a SQL-style filter clause. Optional parameters include fields, layout, showReadOnly, count, start, orderBy, meta, privateLabelId, showEditable, and totalOnly. The response includes detailed information about the JobSubmission, such as id, appointments, billRate, branch, candidate, comments, custom fields, dates, status, and more. If the requested entity cannot be found or if invalid parameters are provided, an HTTP 404 error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_joborder_details
Operation: read
Entities: job
Summary: The Retrieve JobOrder Details API allows users to fetch detailed information about a specific JobOrder using its unique identifier. The API supports various query parameters such as fields, layout, showReadOnly, count, start, orderBy, meta, privateLabelId, showEditable, and totalOnly to customize the response. The response includes comprehensive details about the JobOrder, including its address, benefits, client information, employment type, salary, skills required, and more. This API is useful for retrieving all relevant information about a JobOrder for further processing or display.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_list_of_job_orders
Operation: read
Entities: jobs
Summary: The Retrieve List of Job Orders API allows users to search and retrieve a list of job orders based on various query parameters. The API requires a Lucene-style filter clause as a mandatory query parameter. Users can specify fields or a layout to determine the structure of the response. Optional parameters include count, start, sort, meta, privateLabelId, and showEditable, among others. The response includes detailed information about each job order, such as id, title, client corporation, employment type, date added, status, salary, and location.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_retrieve_all_interview_details_for_an_application
Operation: read
Entities: appointment, interview
Summary: This API retrieves all interview details for a specific application by first obtaining the IDs of appointments associated with a JobSubmission using the GET/query API. The request requires the JobSubmission ID and a SQL-style filter clause. Optional parameters include fields, layout, and various filters. The response includes appointment IDs, which are then used to retrieve detailed information about each appointment using the GET/entity API. The final output includes comprehensive details about each appointment, such as attendees, communication method, dates, description, and more.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_retrieve_all_job_applications
Operation: read
Entities: application, JobSubmission
Summary: The Retrieve All Job Applications API allows users to fetch a list of job applications currently in the system. It requires a Lucene-style query parameter to filter the results and optionally accepts parameters such as fields, layout, count, start, sort, meta, privateLabelId, and showEditable to customize the response. The response includes detailed information about each job application, such as the candidate, status, dates, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

ID: post_create_candidate_note
Operation: write
Entities: note, comment
Summary: The create candidate note API allows you to add a note to a job application using the POST method. The API requires the application ID as a path parameter and the note to update to as part of the request body. The BhRestToken, which represents a session token, can be optionally provided in the headers. The response includes the ID of the changed entity and the type of change made, which is 'UPDATE'.
Input Fields: Input Fields
Output Fields: Output Fields

ID: post_update_application_stage
Operation: write
Entities: stage
Summary: The Update Application Stage API allows you to update the stage of a job application using the POST method. The API requires the application ID as a path parameter and the stage ID to update to as part of the request body. The BhRestToken, which represents a session token, can be optionally provided in the headers or query parameters. The response includes the ID of the changed entity and the type of change made, which is 'UPDATE'.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_attach_documents_to_candidate_application
Operation: write
Entities: attachment
Summary: This API allows you to attach documents such as resumes or cover letters to a candidate's application. The request requires the candidate's ID as a path parameter and the document details such as name, file type, content type, file content, and an optional external ID in the request body. The BhRestToken can be provided in the query string, a cookie, or an HTTP header to represent a session established by the login process. The response returns the ID of the changed entity and the type of change made.
Input Fields: Input Fields
Output Fields: Output Fields

ID: put_create_candidate_and_associate_with_job_order
Operation: write
Entities: application
Summary: This API configuration allows you to create a new candidate and associate them with a job order. The process involves two steps: first, creating a candidate using the PUT /entity/Candidate endpoint, and capturing the changedEntityId from the response. Second, using this changedEntityId as candidateId, associate the candidate with a job order using the PUT /entity/JobSubmission endpoint. The input includes candidate details such as firstName, lastName, phone, and email, as well as the jobOrder ID and status for the job submission. The output returns the changedEntityId and changeType indicating the result of the operation.
Input Fields: Input Fields
Output Fields: Output Fields