HR-Partner API Integration

These are the list of integration use cases supported by Knit for HR-Partner API as part of the HRIS category

Delete A Reminder

ID: delete_a_reminder
Operation: write
Entities: reminder
Summary: This API endpoint deletes a reminder completely from HR Partner. It requires the reminder ID as a path parameter and an API key for authentication in the headers. The request body can include additional details about the reminder, such as its description and status flags. A successful deletion will return an HTTP 200 status code with no content in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Get A Specific Applicant

ID: get_a_specific_applicant
Operation: read
Entities: applicant, job application
Summary: This API endpoint retrieves a specific applicant from the HR Partner system using the Applicant ID or email address. It returns detailed information about the applicant, including their first names, last name, full name, and email address. Additionally, it provides a list of job applications associated with the applicant, detailing each application's ID, job name, current stage, submission date, and various status flags such as whether the application is closed, active, flagged, archived, hired, or read. The source of the application and the total score are also included in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get A Specific Application

ID: get_a_specific_application
Operation: read
Entities: applicant, job listing, job application
Summary: This API endpoint retrieves a single job application from the HR Partner system using the Application ID. The request requires an API key for authentication, provided in the 'x-api-key' header, and the unique 'applicationID' as a path parameter. The response includes detailed information about the application, such as the applicant's details, the current stage of the application, job listing information, custom form answers, scorecards, attachments, interviews, comments, and various status flags. The response also provides the total score of the application.
Input Fields: Input Fields
Output Fields: Output Fields

Get A Specific Employee

ID: get_a_specific_employee
Operation: read
Entities: address detail, contact detail, employee
Summary: This API endpoint retrieves detailed information about a specific employee using their Employee Code. The request requires an API key for authentication and the employee code as a path parameter. The response includes comprehensive details about the employee, such as personal information, contact details, address, custom fields, department, position, and more. The response also includes tags and multiple contact and address entries for the employee.
Input Fields: Input Fields
Output Fields: Output Fields

Get A Specific Job Listing

ID: get_a_specific_job_listing
Operation: read
Entities: department, job, location
Summary: This API endpoint retrieves a specific job listing from the HR Partner system using a unique Job ID. The request requires an API key for authentication and the Job ID as a path parameter. The response includes detailed information about the job listing such as the job title, summary, department, location, employment status, and more. It also includes information about the selection panel, custom application form, scorecard, and application stages.
Input Fields: Input Fields
Output Fields: Output Fields

Get A Specific Leave Request

ID: get_a_specific_leave_request
Operation: read
Entities: leave request, leave approval, employee
Summary: This API endpoint retrieves a specific leave request from the HR Partner system using the unique Leave Request ID. The request requires an API key for authentication, which should be included in the headers. The path parameter 'leaverequestID' is required to specify the leave request to retrieve. The response includes detailed information about the leave request, such as the type, reason, status, duration, and associated employee details. It also includes any actions taken on the request and any attachments linked to it.
Input Fields: Input Fields
Output Fields: Output Fields

Get A Specific Reminder

ID: get_a_specific_reminder
Operation: read
Entities: reminder, module, employee
Summary: This API endpoint retrieves a specific reminder from the HR Partner system using the unique Reminder ID. The request requires an API key for authentication, provided in the 'x-api-key' header, and the 'reminderID' as a path parameter. The response includes details about the reminder such as its description, associated module, reminder time, notification status, and the employee details related to the reminder.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Applicants

ID: get_all_applicants
Operation: read
Entities: system, applicant, job listing
Summary: The 'Get All Applicants' API endpoint retrieves all applicants (candidates for job listings) that are currently in the system. It requires an API key for authentication, which should be included in the request headers. Optionally, a 'search' query parameter can be used to filter applicants by a text string present in their first name, last name, or email. The response is an array of applicant objects, each containing an 'id', 'first_names', 'last_name', 'full_name', and 'email'.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Applications

ID: get_all_applications
Operation: read
Entities: custom form, job listing, job application
Summary: The 'Get All Applications' API endpoint retrieves all job applications for a specific job listing identified by the Job ID. It allows filtering applications based on various query parameters such as source, stage, submission date range, and flags like is_flagged, is_archived, is_hired, and is_read. The API requires an API key for authentication and the job ID as a path parameter. The response includes detailed information about each application, including applicant details, application stage, custom form answers, and submission metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Employees

ID: get_all_employees
Operation: read
Entities: department, location, employee
Summary: The 'Get All Employees' API endpoint retrieves all employees in the system. It supports various query parameters to filter the results, such as 'search', 'department', 'location', 'group', 'position', 'employment_status', 'gender_identity', 'pay_point', 'birth_date_from', 'birth_date_to', 'start_date_from', 'start_date_to', 'end_date_from', 'end_date_to', 'tag', 'is_active', 'is_terminated', 'can_logon', 'eligible_for_rehire', and 'reports_to'. The API requires an 'x-api-key' header for authentication. The response is an array of employee objects, each containing details like 'id', 'code', 'first_names', 'last_name', 'full_name', 'date_of_birth', 'gender_identity', 'is_active', 'is_terminated', 'is_on_leave', 'pay_point', 'department', 'location', 'group', 'position', 'employment_status', 'avatar', 'email', 'started_at', and 'finished_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Expense Claims

ID: get_all_expense_claims
Operation: read
Entities: department, expense claim, employee
Summary: This API endpoint retrieves all expense claims currently in the system. It requires a mandatory query parameter 'report_type' which specifies the type of report to retrieve: 'detailed', 'summary', or 'transaction'. Optional query parameters include 'employee', 'department', 'location', 'expense_date_from', 'expense_date_to', 'submitted_date_from', 'submitted_date_to', 'approved_date_from', 'approved_date_to', 'status', 'is_paid', 'expense_category', and 'project'. The response is an array of expense claims, each containing details such as 'id', 'category', 'details', 'amount', 'status', 'expense_date', 'employee_code', and more.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Job Listings

ID: get_all_job_listings
Operation: read
Entities: department, job listing, location
Summary: The 'Get All Job Listings' API endpoint retrieves all job listings currently available in the system. It supports various query parameters to filter the job listings based on criteria such as department, location, position, employment status, publication dates, and more. The API requires an API key for authentication, which should be included in the request headers. The response is an array of job listings, each containing details such as the job ID, title, summary, publication dates, location, department, position, employment status, and view count. This API is useful for retrieving job listings based on specific search criteria.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Leave Balances

ID: get_all_leave_balances
Operation: read
Entities: leave balance, department, employee
Summary: This API endpoint retrieves all employee leave balances currently in the system. It allows filtering by various query parameters such as absence_reason, employee code, department, location, employment status, position, and whether the employee is active or terminated. The response includes detailed information about each leave balance, including the leave policy name, whether it is external, entitlement, current balance, carryover, units, auto accrual status, and reset dates. Employee details such as code, first names, last name, full name, and department are also included in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Leave Requests

ID: get_all_leave_requests
Operation: read
Entities: leave request, department, employee
Summary: The 'Get All Leave Requests' API endpoint retrieves all employee leave requests currently in the system. It supports various query parameters to filter the results, such as employee code, department, location, leave request type, status, absence reason, and date ranges for leave start and end dates. The API requires an 'x-api-key' header for authentication. The response is an array of leave request objects, each containing details like the leave request type, absence reason, status, description, reason, leave start and end dates, duration, units, notes, and employee information.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Performance Reviews

ID: get_all_performance_reviews
Operation: read
Entities: department, performance review, employee
Summary: This API endpoint retrieves all performance management reviews currently in the system. It allows filtering by various query parameters such as employee code, department, location, position, employment status, review status, and date ranges for assignment, review, and completion. The response includes details of each review, such as its ID, status, template, assignment date, review date, completion date, and employee details. The API can also return form data and answers if specified, which may increase response time.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Projects/Activities

ID: get_all_projects_activities
Operation: read
Entities: project, activity, employee
Summary: This API endpoint retrieves all projects and activities currently in the system. It supports various query parameters to filter the results, such as employee code, department, location, project name, activity name, expense category, currency, and transaction date range. The response includes detailed information about each project and activity, including project description, activity category, employee details, transaction date, value, cost, charge, transaction type, currency, and notes.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Reminders

ID: get_all_reminders
Operation: read
Entities: department, reminder, employee
Summary: The 'Get All Reminders' API endpoint retrieves all reminders currently in the system. It supports various query parameters to filter reminders based on employee code, department, user email, module, and flags such as send_notification, notification_sent, and active. The API requires an API key for authorization. The response includes details of each reminder, such as its ID, description, module, reminder time, notification flags, and information about the employee and the person who set the reminder.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Timesheets

ID: get_all_timesheets
Operation: read
Entities: timesheet, project, employee
Summary: The 'Get All Timesheets' API endpoint retrieves all timesheets currently in the system, grouped by Timesheet Template, sequence, employee, and individual time entries. The API supports various query parameters to filter the timesheets, such as employee code, department, location, group, timesheet template name, date ranges, status, project, activity, approval status, export status, and lock status. The response includes detailed information about each timesheet, including the template, frequency, entry method, rounding, dates, status, approval, export status, total time, approving user, employee details, and time entry details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Application Stage Tracking

ID: get_application_stage_tracking
Operation: read
Entities: applicant, job application, stage tracking
Summary: This API endpoint retrieves all job applications stage tracking information in the system. It allows users to track the movement of job applications within the recruitment module over time. The API supports filtering by job ID, applicant email or ID, stage transitions, and date ranges. The response includes detailed information about each stage transition, such as applicant details, job details, and the stages involved.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Company Data from HR Partner

ID: get_company_data_from_hr_partner
Operation: read
Entities: employee count, subscription, company
Summary: This API endpoint retrieves basic company data from HR Partner. It requires an API key for authentication, which should be included in the request headers. The response includes details such as the company name, logo image link, subscription status and expiry date, employee limits and counts, timezone, and available SMS credits. This endpoint is useful for validating communication with the correct HR Partner company.
Input Fields: Input Fields
Output Fields: Output Fields

Dependents Records Retrieval

ID: get_dependents_records
Operation: read
Entities: dependent, attachment, employee
Summary: The Dependents Records Retrieval API allows users to fetch records of dependents, such as spouses, kids, or family members related to employees. Users can filter the records using various query parameters like employee code, department, dependent type, name, contact details, comments, and date of birth range. The response includes detailed information about each dependent, including their type, name, contact details, date of birth, and associated employee details. If available, attachments related to the dependent are also included in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Absence Records

ID: get_employee_absence_records
Operation: read
Entities: absence, department, employee
Summary: The Retrieve Employee Absence Records API allows users to fetch records of employee absences, including leave or vacation time taken off, as well as TOIL/Flexi time added back. The API supports various query parameters to filter results, such as employee code, department, location, group, leave type, absence reason, duration, physician, certificate number, absence status, comments, and date range. The response includes detailed information about each absence record, such as leave type, reason, description, dates, duration, physician, certificate number, status, comments, and employee details. If attachments are present, they are returned as an array of objects with file details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Anniversaries

ID: get_employee_anniversaries
Operation: read
Entities: department, employee, anniversary
Summary: The Get Employee Anniversaries API returns an abbreviated list of active, non-terminated employees along with core details and their length of employment. The API allows filtering by department, location, position, group, employment status, and specific months or years. The response includes employee details such as name, date of birth, gender identity, department, location, position, employment status, avatar URL, email, start date, and years worked. This API is useful for generating reports on employee anniversaries and forecasting employee length of service.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Asset Records

ID: get_employee_asset_records
Operation: read
Entities: department, asset, employee
Summary: The Retrieve Employee Asset Records API allows users to fetch records of company equipment that is on loan to employees. The API endpoint is 'GET https://api.hrpartner.io/assets'. Users can filter the asset records using various query parameters such as 'employee' to specify the employee code, 'department' to filter by department names, 'description' to search within the asset description, 'asset_identifier' for the asset identifier, 'serial_number' for the serial number, 'asset_type' for the type of asset, and date ranges for when the asset was allocated ('out_date_from', 'out_date_to') or returned ('in_date_from', 'in_date_to'). The response includes details of each asset, such as its type, description, identifier, serial number, allocation and return dates, and the employee's details. If an asset record includes attachments, they are returned as an object array with details like file name, URL, and size.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Attachments

ID: get_employee_attachments
Operation: read
Entities: attachment, module, employee
Summary: The Retrieve Employee Attachments API allows users to fetch records of all file attachments for employees within the company. It supports filtering by employee code, department names, description text, module, and upload date range. The API requires an API key for authentication. The response includes details such as attachment ID, description, URL, module, size, upload date, and associated employee information.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Benefits

ID: get_employee_benefits
Operation: read
Entities: benefit, department, employee
Summary: The Retrieve Employee Benefits API allows users to fetch records of additional benefits or allowance plans that employees may be enrolled in. The API supports various query parameters to filter results, such as employee code, department, benefit type, status, description, comments, start and end dates, and benefit value range. The response includes detailed information about each benefit, including its description, value, type, provider, status, and associated employee details. If available, attachments related to the benefit are also included in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Birthdays

ID: get_employee_birthdays
Operation: read
Entities: department, location, employee
Summary: The Get Employee Birthdays API returns a list of active, non-terminated employees with their core details and calculated age at the time of the call. The API allows filtering by department, location, position, employment status, start month, end month, and selected year. The response includes employee details such as code, name, date of birth, age, gender identity, department, location, position, employment status, avatar URL, email, and employment dates.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Education Records

ID: get_employee_education_records
Operation: read
Entities: institution, education record, employee
Summary: The Retrieve Employee Education Records API allows users to fetch records of educational institutions attended by employees before joining the company. The API supports various query parameters to filter results, such as employee code, department, education type, status, institution, qualification, comments, and date ranges for commencement and completion. The response includes detailed information about each education record, including institution name, dates, type, status, and associated employee details. If attachments are present, they are returned as an array within the education record.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Grievance Records

ID: get_employee_grievance_records
Operation: read
Entities: grievance, department, employee
Summary: The Retrieve Employee Grievance Records API allows users to fetch records of grievances such as complaints or harassment filed against employees. Users can filter the records based on various query parameters such as employee code, department, grievance type, status, description, actioned by, and reported date range. The response includes detailed information about each grievance, including the type, description, reported date, actioned by, status, comments, and employee details. If attachments are present, they are returned as an object array within the grievance record.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Notes

ID: get_employee_notes
Operation: read
Entities: note, attachment, employee
Summary: The Retrieve Employee Notes API allows users to fetch free-form notes associated with employees. Users can filter notes by employee code, department, note content, creation date range, update date range, and tags. The API returns a list of notes, each containing details such as the note content, creation and update timestamps, and employee information. If notes have attachments, they are included as an array of objects with details like file name, URL, and size.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Performance Reviews

ID: get_employee_performance_reviews
Operation: read
Entities: review, department, employee
Summary: The Retrieve Employee Performance Reviews API allows users to fetch records of performance reviews for employees. The API endpoint is 'GET https://api.hrpartner.io/reviews'. Users can filter the reviews based on various query parameters such as employee code, department, review type, review status, description, comments, reviewer, score range, and review date range. The response includes detailed information about each review, including the review type, description, date, reviewer, score, status, comments, and employee details. If a review includes attachments, they are returned as an object array with details such as description, URL, and size.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Position Records

ID: get_employee_position_records
Operation: read
Entities: position, department, employee
Summary: The Retrieve Employee Position Records API allows users to fetch records of positions or employment contracts associated with employees. The API supports various query parameters to filter results, such as employee code, department, position name, comments, remuneration range, pay level, and commencement or completion dates. The response includes detailed information about each position, including the position name, dates, remuneration, comments, and associated employee details. If attachments are present, they are returned as an array of objects containing the file description, URL, and size.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Employee Skills Records

ID: get_employee_skills_records
Operation: read
Entities: department, skill, employee
Summary: The Retrieve Employee Skills Records API allows users to fetch records of skills and abilities associated with employees. Users can filter results by employee code, department, skill name, skill rating, and comments. The API requires an API key for authentication. The response includes details such as skill name, rating, comments, and employee information including code, name, and department.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Interview Records

ID: get_interview_records
Operation: read
Entities: department, interview, employee
Summary: The Retrieve Interview Records API allows users to fetch records of interviews or meetings associated with employees. The API endpoint is accessed via a GET request to 'https://api.hrpartner.io/interviews'. Users can filter the results using query parameters such as 'employee' for employee code, 'department' for department names, 'interview_type' for the type of interview, 'description' for partial text in the description, 'interviewer' for partial name of the interviewer, and date range parameters 'interview_date_from' and 'interview_date_to'. The response includes details of each interview, such as the interview type, description, interviewer, date, comments, and employee details. If attachments are present, they are returned as an array of objects containing the file description, URL, and size.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Renewable Document Records

ID: get_renewable_document_records
Operation: read
Entities: renewable document, department, employee
Summary: The Retrieve Renewable Document Records API allows users to fetch records of renewable documents associated with employees. The API endpoint is 'GET https://api.hrpartner.io/renewables'. It supports various query parameters such as 'employee', 'department', 'renewable_type', 'description', 'comments', 'issue_date_from', 'issue_date_to', 'renewal_date_from', and 'renewal_date_to' to filter the results. The response includes details of each renewable record, such as 'id', 'renewable_type', 'description', 'issue_date', 'renewal_due', 'comments', and employee details. If attachments are present, they are returned as an array with 'description', 'url', and 'size'.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Lookup Information

ID: get_retrieve_lookup_information
Operation: read
Entities: position, department, lookup file
Summary: This API endpoint retrieves information from any of the lookup files used in the drop-downs within HR Partner. The endpoint requires a path parameter 'lookupName' which specifies the type of lookup information to retrieve, such as absence reasons, asset types, or positions. The request must include an 'x-api-key' header for authentication. The response is an array of objects, each containing an 'id' and 'name' representing the lookup items.
Input Fields: Input Fields
Output Fields: Output Fields

Training Records Retrieval

ID: get_training_records
Operation: read
Entities: training course, department, employee
Summary: The Training Records Retrieval API allows users to access records of internal or external training courses associated with employees. Users can filter the training records based on various query parameters such as employee code, department, training type, training status, course name, institution, comments, cost range, reimbursement range, and date ranges for commencement and completion. The API returns detailed information about each training record, including the training type, course name, institution, dates, status, cost, reimbursement, comments, and employee details. If available, attachments related to the training are also included in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Add A Timesheet/Timeclock Entry

ID: post_add_a_timesheet_timeclock_entry
Operation: write
Entities: timesheet, timeclock entry, employee
Summary: The 'Add A Timesheet/Timeclock Entry' API allows users to create a new timesheet entry for an employee. The API requires either an employee code or email, along with start and end times in ISO-8601 format. Optional parameters include duration, break time, notes, project name, and activity name. The request must be authenticated using an API key. A successful request returns a message confirming the creation of the timesheet entry, while errors are returned as JSON messages.
Input Fields: Input Fields
Output Fields: Output Fields

Add or Update An Applicant

ID: post_add_or_update_an_applicant
Operation: write
Entities: applicant, job listing, job application
Summary: This API endpoint allows you to add or update an applicant's information and their job application details. The request requires an API key for authentication and must include the applicant's email address. Optionally, you can provide the applicant's first and last names, and an array of job applications they are applying for. Each job application must include a unique job listing ID and can include the stage of the application process. The response returns the updated applicant object, including their full name, email, and details of their job applications such as the job ID, name, stage, submission date, and status flags.
Input Fields: Input Fields
Output Fields: Output Fields

Add or Update An Application

ID: post_add_or_update_an_application
Operation: write
Entities: applicant, job listing, application
Summary: The 'Add or Update An Application' API endpoint allows users to either create a new job application or update certain fields of an existing application. The API requires a POST request to the endpoint 'https://api.hrpartner.io/application'. The request must include headers for authentication ('x-api-key') and content type ('Content-Type'). The body of the request can include an 'id' to update an existing application, or omit it to create a new one. The body must also include applicant details such as 'email', 'first_names', and 'last_name', job listing details with a unique 'id', and optionally, the stage of the application process. Additionally, users can provide custom form fields and their answers in the 'custom_form' section. The response includes the custom form fields and their answers.
Input Fields: Input Fields
Output Fields: Output Fields

Update A Reminder

ID: post_update_a_reminder
Operation: write
Entities: reminder, notification, employee
Summary: This API endpoint allows you to update certain fields on a reminder in the HR Partner system. The request is made using the POST method to the URL 'https://api.hrpartner.io/reminder/{reminderID}', where 'reminderID' is the ID of the reminder you wish to update. The request must include the 'x-api-key' and 'Content-Type' headers. The body of the request should include the reminder ID, which is mandatory, and optionally the description, send_notification, notification_sent, and active fields. The response will return a reminder object with details such as the reminder ID, description, module, module ID, remind_at time, notification flags, and information about the user who set the reminder and the associated employee.
Input Fields: Input Fields
Output Fields: Output Fields

Update/Add An Employee

ID: post_update_add_an_employee
Operation: write
Entities: address, contact, employee
Summary: This API endpoint allows for updating an existing employee or adding a new employee if the employee code does not exist. The request is made to the URL 'https://api.hrpartner.io/employee/{employeeCode}' using the POST method. The request requires an API key in the headers for authentication and a JSON body containing employee details. The body must include the employee code if updating an existing employee, but it is not required if creating a new employee. Other optional details include first names, last name, date of birth, gender identity, tax number, employment status, and more. The response returns an employee object with details such as the employee's full name, avatar URL, employment status, and contact information. The API also supports custom data fields and tags for the employee.
Input Fields: Input Fields
Output Fields: Output Fields