JobDiva API Integration

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

Get Candidate Application Records

ID: get_candidate_application_records
Operation: read
Entities: candidate application record, candidate, candidate qualification
Summary: The Get Candidate Application Records API retrieves candidate application records within a specified date range. It requires 'fromDate' and 'toDate' as query parameters in the format MM/dd/yyyy HH:mm:ss. Optional parameters include 'pageNumber' and 'pageSize' for pagination. The response includes candidate details such as name, contact information, qualifications, and status.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_candidate_details
Operation: read
Entities: user defined field, candidate, candidate qualification
Summary: The Get Candidate Details API retrieves detailed information about a candidate using their internal JD candidate ID. It accepts query parameters such as 'candidateId' which is required, and 'userFieldsName' which is optional and allows for the inclusion of user-defined fields in the response. The response includes a comprehensive set of candidate details such as address, contact information, qualifications, and user-defined fields.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_job_details
Operation: read
Entities: job, department, user field
Summary: The Get Job Details API retrieves detailed information about a specific job. It accepts query parameters such as jobId, jobdivaref, and userFieldsName to filter the job details. The response includes a comprehensive set of job attributes such as address, company, job description, job status, and more. The API returns a 200 status code with job details on success, and appropriate error codes for unauthorized, forbidden, or not found scenarios.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_new_updated_job_records
Operation: read
Entities: job, department, company
Summary: The Get New and Updated Job Records API retrieves a list of job records that have been newly created or updated within a specified date range. The API requires 'fromDate' and 'toDate' as mandatory query parameters to define the date range. Optional parameters include 'userFieldsName' to specify user-defined fields, 'pageNumber' for pagination, and 'pageSize' to limit the number of records per page. The response includes a list of job objects with detailed information such as job title, description, company, location, and other relevant job details.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_new_updated_submittal_interview_hire_activity_records
Operation: read
Entities: interview, submittal, candidate
Summary: The Get New Updated Submittal Interview Hire Activity Records API retrieves a list of submittal objects based on the specified date range and optional user fields. The API requires 'fromDate' and 'toDate' as query parameters in the format MM/dd/yyyy HH:mm:ss. Optional parameters include 'userFieldsName' for specifying user fields, 'pageNumber' for pagination, and 'pageSize' for the number of records per page. The response includes a list of submittal objects with details such as candidate information, job details, and submittal status.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_submittals_detail
Operation: read
Entities: interview schedule, submittal, user field
Summary: The Get Submittals Detail API retrieves detailed information about submittals based on the provided interview schedule IDs and user field names. The API accepts query parameters 'interviewScheduleIds' and 'userFieldsName', both of which are optional. The response includes detailed information about each submittal, such as candidate details, pay rates, job details, and submittal status. The API returns a 200 OK response with the submittal data model if successful, and may return 401 Unauthorized, 403 Forbidden, or 404 Not Found for error cases.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_user_detail
Operation: read
Entities: job title, address, user
Summary: The Get User Detail API retrieves detailed information about a user based on the provided query parameters. The API accepts three optional query parameters: userId, userEmail, and userAlternateEmail. The response includes a comprehensive user model containing fields such as address, city, country, email, first name, last name, job title, and more. The API returns a 200 OK status with the user details if successful, or appropriate error codes such as 401 Unauthorized, 403 Forbidden, or 404 Not Found in case of errors.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_users_list
Operation: read
Entities: user model, user
Summary: The Get Users List API retrieves a list of users. It accepts an optional query parameter 'onlyInternalUsers' to filter the list to only include internal users. The response includes a list of user objects, each containing details such as address, email, phone numbers, job title, and more. The API returns a 200 status code on success, with possible error codes including 401 for Unauthorized, 403 for Forbidden, and 404 for Not Found.
Input Fields: Input Fields
Output Fields: Output Fields

ID: post_create_candidate
Operation: write
Entities: profile, candidate, skill
Summary: The Create Candidate API allows users to create a new candidate profile in the system. The API requires a POST request to the endpoint /apiv2/jobdiva/createCandidate. The request body must include the candidate's first and last name, and can optionally include additional details such as email, address, phone numbers, salary information, and more. The response will return the ID of the created candidate if successful. The API supports various fields for candidate details, including education, skills, certifications, and user-defined fields.
Input Fields: Input Fields
Output Fields: Output Fields

ID: post_create_candidate_note
Operation: write
Entities: note, candidate, recruiter
Summary: The Create Candidate Note API allows users to create a note for a candidate in the system. The request requires a candidate ID and a note as mandatory fields. Optional fields include recruiter ID, action, action date, links to an open job or contact, and a flag to set the note as auto. The response returns a status code indicating the result of the operation, with 200 for success, 201 for created, 401 for unauthorized, 403 for forbidden, and 404 for not found.
Input Fields: Input Fields
Output Fields: Output Fields

ID: post_update_candidate_attribute
Operation: write
Entities: qualification, candidate, candidate attribute
Summary: The Update Candidate Attribute API allows users to update specific attributes of a candidate in the JobDiva system. The API requires a POST request to the endpoint /apiv2/jobdiva/updateCandidateAttribute. The request body must include the candidateId, which is the unique identifier of the candidate, and the text, which is the attribute to be updated. The response will be a boolean indicating the success of the operation. Possible response codes include 200 (OK), 201 (Created), 401 (Unauthorized), 403 (Forbidden), and 404 (Not Found).
Input Fields: Input Fields
Output Fields: Output Fields