JazzHR ATS API Integration

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

Find Activity By ID

ID: get_activity_by_id
Operation: read
Entities: user, activity, object
Summary: The 'Find Activity By ID' API allows users to retrieve details of a specific activity by its ID. The request requires the 'activity_id' as a path parameter and an 'apikey' as a query parameter for authentication. The response includes details such as the activity ID, category, user ID, object ID, action description, date, and time of the activity. The response is returned in JSON format with a content-type header of 'application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Find Applicant2Jobs Details By ID

ID: get_applicant2jobs_details_by_id
Operation: read
Entities: workflow step, job, applicant
Summary: The 'Find Applicant2Jobs Details By ID' API retrieves a single Applicants2Jobs record using the specified applicants2jobsID. The request requires the applicants2jobsID as a path parameter and an API key as a query parameter for authentication. The response includes details such as the applicant ID, job ID, rating, workflow step ID, and the date of the record. The response is returned in JSON format with a content-type header of 'application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Find applicant by ID

ID: get_applicant_by_id
Operation: read
Entities: evaluation, job, applicant
Summary: The 'Find applicant by ID' API allows users to retrieve detailed information about a specific applicant using their unique applicant ID. The API requires the applicant's ID as a path parameter and an API key as a query parameter. Upon a successful GET request, it returns a JSON response containing comprehensive details about the applicant, including personal information, application details, and various statuses. The response includes fields such as first name, last name, email, location, desired salary, and more, along with arrays for jobs, comments, feedback, and other related data.
Input Fields: Input Fields
Output Fields: Output Fields

Find Applicants2Jobs Mapping By Parameters

ID: get_applicants2jobs_mapping_by_parameters
Operation: read
Entities:
Summary: The 'Find Applicants2Jobs Mapping By Parameters' API allows users to retrieve mappings between applicants and jobs based on various parameters. The API supports filtering by applicant ID, job ID, hiring manager rating, and workflow step ID. The endpoint requires an API key for authentication. The response includes details such as the unique mapping ID, applicant ID, job ID, rating, workflow step ID, and the date of the mapping. The response is returned in JSON format with a content-type of application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Find candidates who were hired

ID: get_candidates_hired
Operation: read
Entities: job, candidate, hire
Summary: This API endpoint retrieves a list of candidates who were hired, ordered by the hired date. It requires an API key for authentication, which should be included in the headers. The endpoint supports pagination, with 100 results per page, and the page number can be specified as a path parameter. The response includes details such as the hire ID, applicant ID, job ID, workflow step ID and name, and the date and time the candidate was hired. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Find categories2applicants By parameters

ID: get_categories2applicants_by_parameters
Operation: read
Entities: applicant, category
Summary: The 'Find categories2applicants By parameters' API allows users to retrieve information about the association between categories and applicants based on specified parameters. The API accepts query parameters such as 'applicant_id', 'category_id', and 'page' to filter the results. The response includes a JSON object with the 'id', 'applicant_id', and 'category_id' of the matching entries. The API returns a maximum of 100 results per page, and the response content type is 'application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Find Category Details By ID

ID: get_category_details_by_id
Operation: read
Entities: user, category
Summary: The 'Find Category Details By ID' API retrieves the details of a specific category using its ID. The API requires an API key for authentication, which should be included in the headers. The category ID is a required path parameter. The response includes the category's ID, name, status, the user who created it, and the date it was created. The response is returned in JSON format with a content-type of application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Find applicant by ID

ID: get_details_of_a_specific_job_application
Operation: read
Entities:
Summary: The 'Find applicant by ID' API allows users to retrieve detailed information about a specific applicant using their unique applicant ID. The API requires the applicant's ID as a path parameter and an API key as a query parameter. Upon a successful GET request, it returns a JSON response containing comprehensive details about the applicant, including personal information, application details, and various statuses. The response includes fields such as first name, last name, email, location, desired salary, and more, along with arrays for jobs, comments, feedback, and other related data.
Input Fields: Input Fields
Output Fields: Output Fields

Find File Details By ID

ID: get_file_details_by_id
Operation: read
Entities: file
Summary: The 'Find File Details By ID' API retrieves the details of a specific file using its ID. The request requires an API key for authentication, which should be included in the headers. The file ID is a required path parameter. The API returns a JSON response containing the file's details, such as its ID, name, size, and type. The response headers include the content type, which is 'application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Files By Parameters

ID: get_files_by_parameters
Operation:
Entities:
Summary: The 'Files By Parameters' API allows users to retrieve files based on various optional query parameters such as user_id, applicant_id, from_creation_date, and to_creation_date. The API requires an API key for authentication. The response includes details about the files such as id, applicant_id, filename, mime_type, user_id, file_privacy, file_size, date_loaded, time_loaded, and a file_url for downloading the file. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Find Activities By Parameters

ID: get_find_activities_by_parameters
Operation: read
Entities: user, job, activity
Summary: The 'Find Activities By Parameters' API allows users to retrieve a list of activities based on specified query parameters such as user_id, object_id, and category. The API uses the GET method and does not require any specific headers or request body. The response includes a list of activities with details such as activity ID, category, user ID, object ID, action description, date, and time. The response is returned in JSON format with a content-type of application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Find applicants by parameters

ID: get_find_applicants_by_parameters
Operation: read
Entities: job, applicant, recruiter
Summary: The 'Find applicants by parameters' API allows users to retrieve a list of applicants based on various search criteria. The API uses the GET method and requires query parameters to filter the applicants. These parameters include name, city, job_id, job_title, recruiter_id, apply_date, from_apply_date, to_apply_date, status, and rating. The endpoint for this API is 'https://api.resumatorapi.com/v1/applicants'. The response is a JSON array of applicants, each containing details such as id, first_name, last_name, prospect_phone, apply_date, job_id, and job_title. The response headers include 'content-type: application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Find Categories By Parameters

ID: get_find_categories_by_parameters
Operation:
Entities:
Summary: The 'Find Categories By Parameters' API allows users to retrieve categories based on various optional query parameters such as user_id, name, status, from_creation_date, and to_creation_date. The API requires an 'apikey' in the headers for authentication. The response includes details of the categories such as id, name, status, created_by, and date_created. The endpoint returns a JSON response with a 200 status code and content-type as application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Find Contact By ID

ID: get_find_contact_by_id
Operation: read
Entities: contact, owner
Summary: The 'Find Contact By ID' API retrieves details of a specific contact using their unique contact ID. The API requires the contact ID as a path parameter and an API key as a query parameter for authentication. The response includes detailed information about the contact such as their name, email, company, address, phone numbers, and other personal details. The response is returned in JSON format with a status code of 200.
Input Fields: Input Fields
Output Fields: Output Fields

Find Contacts By Parameters

ID: get_find_contacts_by_parameters
Operation: read
Entities: user, contact, note
Summary: The 'Find Contacts By Parameters' API allows users to retrieve contact information based on specified parameters such as 'from_date' and 'to_date'. The API uses the GET method and requires an API key for authentication. The endpoint is 'https://api.resumatorapi.com/v1/contacts'. Users can optionally provide 'from_date' and 'to_date' as query parameters to filter contacts by their creation or modification dates. The response includes detailed contact information such as first and last name, email, company name, address, phone numbers, and more. The response is returned in JSON format with a content-type of 'application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Find Job By ID

ID: get_find_job_by_id
Operation: read
Entities: prospect, job, hiring lead
Summary: The 'Find Job By ID' API allows users to retrieve detailed information about a specific job using its unique job ID. The API requires the job ID as a path parameter and an API key as a query parameter for authentication. Upon a successful GET request, it returns a JSON response containing comprehensive details about the job, including its title, location, description, salary range, status, and a list of applicants. The response also includes metadata such as the job's original open date, type, and associated codes.
Input Fields: Input Fields
Output Fields: Output Fields

Find Jobs By Parameters

ID: get_find_jobs_by_parameters
Operation: read
Entities: prospect, job, department
Summary: The 'Find Jobs By Parameters' API allows users to search for jobs using various query parameters such as job title, recruiter, board code, department, hiring lead, state, city, open date range, status, confidentiality, privacy, and page number for pagination. The API endpoint is 'https://api.resumatorapi.com/v1/jobs' and uses the GET method. Users can provide any combination of these parameters to filter the job listings. The response includes detailed information about each job, such as its ID, title, location, department, description, salary range, status, and a list of applicants. The response is returned in JSON format with a content-type of 'application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Find Task By ID

ID: get_find_task_by_id
Operation: read
Entities: prospect, task, user
Summary: The 'Find Task By ID' API allows users to retrieve details of a specific task using its unique task ID. The API requires the task ID as a path parameter and an API key as a query parameter for authentication. Upon a successful request, it returns a JSON response containing detailed information about the task, including its ID, associated object ID, owner and assignee details, status, description, notes, due date, and creation timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Find Tasks By Parameters

ID: get_find_tasks_by_parameters
Operation: read
Entities: prospect, task, user
Summary: The 'Find Tasks By Parameters' API allows users to retrieve tasks based on specific query parameters such as 'from_date', 'to_date', and 'status'. This API uses the GET method and does not require any headers or body in the request. The response includes detailed information about each task, such as its ID, status, description, and creation details. The response is returned in JSON format with a content-type of application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Find Users By Parameters

ID: get_find_users_by_parameters
Operation: read
Entities: user
Summary: The 'Find Users By Parameters' API allows users to search for users based on various parameters such as name, email, and type. The API uses the GET method and requires an API key for authentication. The endpoint is 'https://api.resumatorapi.com/v1/users'. Users can provide any combination of the query parameters 'name', 'email', and 'type' to filter the search results. The response includes details about the user such as their unique ID, type, last name, first name, email, and the date they were created. The response is returned in JSON format with a content-type header of 'application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Hiring Manager Details for Job

ID: get_hiring_managers_for_a_job
Operation: read
Entities:
Summary: The 'Get Hiring Manager Details for Job' API configuration allows users to retrieve detailed information about the hiring manager associated with a specific job. The process involves two steps: first, using the 'Find Job By ID' API to obtain the hiring lead ID from the job details, and second, using the 'Find User By ID' API to fetch the user details of the hiring lead. The input requires the job ID as a path parameter and an API key in the headers for authentication. The final output includes the hiring manager's ID, type, name, email, creation date, and a list of activities associated with the user, all returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Find Prospect2Category Details By ID

ID: get_prospect2category_details_by_id
Operation: read
Entities: prospect, prospect to category, category
Summary: The 'Find Prospect2Category Details By ID' API retrieves details of a specific Prospect2Category using its ID. The API requires the 'categories2applicantsID' as a path parameter and an 'apikey' as a query parameter for authentication. The response includes the ID of the Prospect2Category, the applicant ID, and the category ID. The response is returned in JSON format with a content-type of 'application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Find Questionnaire Answers by ID

ID: get_questionnaire_answers_by_id
Operation: read
Entities: job, applicant, questionnaire
Summary: The 'Find Questionnaire Answers by ID' API allows users to retrieve answers to questionnaires based on various parameters such as questionnaire_id, applicant_id, job_id, and page number. The API uses the GET method and returns a list of questionnaire answers in JSON format. Each answer includes details such as job_id, applicant_id, questionnaire_id, questionnaire_code, date_taken, and time_taken. Optional fields like answer_value_01 and answer_correct_01 may also be present. The response is paginated, with 100 results per page.
Input Fields: Input Fields
Output Fields: Output Fields

Get Questionnaire Questions By Parameters

ID: get_questionnaire_questions_by_parameters
Operation: read
Entities: parameter, question, questionnaire
Summary: The 'Get Questionnaire Questions By Parameters' API allows users to retrieve questions from a specific questionnaire by providing the questionnaire ID and optionally filtering by question status. The API requires the 'questionnaire_id' as a mandatory query parameter and 'question_status' as an optional parameter. The response includes details about each question such as the question text, format, order, and status. The response is returned in JSON format with a content-type of 'application/json'.
Input Fields: Input Fields
Output Fields: Output Fields

Find User By ID

ID: get_user_by_id
Operation: read
Entities: user, user activity
Summary: The 'Find User By ID' API allows you to retrieve detailed information about a specific user by their unique ID. This API uses the GET method and requires the user ID as a path parameter. The request must include an API key in the headers for authentication. The response includes the user's ID, type, name, email, creation date, and a list of activities associated with the user. The response is returned in JSON format with a content-type of application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Post Applicants2Jobs Mapping

ID: post_applicants2jobs_mapping
Operation: write
Entities: job, applicant, workflow
Summary: The Post Applicants2Jobs Mapping API allows users to map applicants to jobs by providing the applicant ID and job ID. The API requires an API key and accepts additional optional parameters such as workflow_step_id, rating, and submission_date. The response includes an appjob_id which is the ID of the applicant-job mapping. The request must include the Content-Type header set to application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Post Category

ID: post_category
Operation: write
Entities: category
Summary: The Post Category API allows users to create a new category by providing a name and optionally a status. The request requires an API key for authentication and the 'Content-Type' header set to 'application/json'. The 'name' parameter is mandatory and represents the string tag for the category. The 'status' parameter is optional and can be set to 'Enabled' or 'Disabled'. Upon successful creation, the API returns a unique category ID and an associated aid in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Post Category2Applicant Mapping

ID: post_category2applicant_mapping
Operation: write
Entities: mapping, applicant, category
Summary: The Post Category2Applicant Mapping API allows users to create a mapping between a category and an applicant. It requires the applicant_id and category_id as input parameters, both of which are mandatory. The request must include an API key for authentication. The API returns a pro2cat_id in the response body, which is the ID of the created mapping. The response is returned with a status code of 200 and a content-type of application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Job

ID: post_create_a_job
Operation: write
Entities: user, job, department
Summary: The Create a Job API allows users to create a new job posting by providing various details such as the job title, hiring lead ID, employment type, minimum experience, job description, and more. The API requires a valid API key and certain mandatory fields like title, hiring_lead_id, description, and workflow_id. Optional fields include employment type, minimum experience, country, job status, and various canned responses for additional job details. The API returns a job_id upon successful creation of the job.
Input Fields: Input Fields
Output Fields: Output Fields

Create an applicant

ID: post_create_an_applicant
Operation: write
Entities: prospect, job, applicant
Summary: The 'Create an applicant' API allows users to create a new applicant profile and optionally apply them to a single job. The API requires the first name, last name, and email of the applicant as mandatory fields. Additional optional fields include apply date, address, city, state, postal code, phone, job ID, workflow step ID, cover letter, source, referral, and various other personal and professional details. The API returns a unique prospect ID for the created applicant. The response is in JSON format with a 200 status code indicating success.
Input Fields: Input Fields
Output Fields: Output Fields

Post File

ID: post_file
Operation: write
Entities: user, file, applicant
Summary: The Post File API allows users to upload a file associated with an applicant. It requires the applicant's ID, the filename, and the file data in Base64 format. Optionally, the user ID of the uploader and file privacy settings can be included. The API returns a file ID and a URL to download the file, which requires logging into Jazz. The request must include an API key for authentication and the content type should be set to application/json.
Input Fields: Input Fields
Output Fields: Output Fields

Post Notes

ID: post_notes
Operation: write
Entities: prospect, note, user
Summary: The Post Notes API allows users to create a note associated with a specific applicant. The request requires an API key and an applicant ID. Optional parameters include user ID, contents of the note, and security level. The response returns a comment ID indicating the successful creation of the note. The API uses the POST method and expects a JSON payload.
Input Fields: Input Fields
Output Fields: Output Fields

Post Questionnaire Answers

ID: post_questionnaire_answers
Operation: write
Entities: applicant, questionnaire
Summary: The Post Questionnaire Answers API allows users to submit answers to a questionnaire. It requires the applicant's ID and the questionnaire ID as mandatory fields. Optionally, a job ID can be provided if the questionnaire is associated with a job. The API accepts up to 20 answer values, each as a string. The response returns a unique ID for the posted questionnaire answer.
Input Fields: Input Fields
Output Fields: Output Fields