Hailey HR API Integration

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

Get all job ads for your company

• ID: get_all_job_ads_for_your_company
• Operation: read
• Entities: custom input field, job ad, career page
• Summary: This API endpoint retrieves all job advertisements for a company. It does not require any request parameters or body. The response includes a list of job ads, each with details such as jobAdId, publishedDateTime, title, subtitle, jobDescription, logotypeFileId, coverImageFileId, contactPersonEmployeeId, careerPageId, showLocation, showDepartment, and customInputFields. The API returns a 200 status code with job ads if found, a 401 status code if unauthorized, a 404 status code if no job ads are found, and a 400 status code for a bad request.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get all salaries on your employees.

• ID: get_all_salaries_on_your_employees
• Operation: read
• Entities: salary, employee
• Summary: This API endpoint retrieves all salaries for employees. It uses the GET method and does not require any request body, headers, or parameters. The response can be a 200 status code with an array of salary objects if salaries are found, a 401 status code if unauthorized, or a 404 status code if no salaries are found.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get a list of all changes in the company

• ID: get_list_of_all_changes_in_the_company
• Operation: read
• Entities: employee, company, change
• Summary: This API retrieves a list of all changes in the company. It accepts optional query parameters such as 'changeDateOrEffectiveDate', 'fromDate', and 'toDate' to filter the changes based on specific dates. The response includes an array of changes, each detailing the employee ID, change date, effective date, the field that was changed, old and new values, and whether the field is a custom field. The API returns a 200 status code for success, 201 if changes are found, 401 if unauthorized, and 400 if the period is invalid.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get a list of all Employees in your Company

• ID: get_list_of_all_employees_in_your_company
• Operation: read
• Entities: department, company, employee
• Summary: This API retrieves a list of all employees in your company. The data returned depends on the rights you have in Hailey. The API does not require any request parameters or body. The response includes a list of employees with detailed information such as employee ID, account status, contact details, employment details, and more. The response can return a 200 status code with the employee data, a 404 status code if the company or employees are not found, or a 401 status code if unauthorized.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get a publicly available list of Employees in your Company for use in third party applications

• ID: get_publicly_available_list_of_employees
• Operation: read
• Entities: department, company, employee
• Summary: This API retrieves a publicly available list of employees in a specified company for use in third-party applications, such as a website. The endpoint requires a path parameter 'companyId', which is a UUID representing the unique identifier of the company. The response includes basic employee information such as titles, department, location, first name, last name, profile image URI, company email, and work phone. If the company has not activated the public employee list, a 403 response is returned.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get salary data for specific SalaryId

• ID: get_salary_data_for_specific_salaryid
• Operation: read
• Entities: salary ID, salary, employee
• Summary: This API retrieves salary data for a specific SalaryId. It requires a query parameter 'salaryId' which is a UUID representing the unique identifier for the salary record. The API responds with a 200 status code and the salary details if found, a 401 status code if the request is unauthorized, and a 404 status code if the salary is not found.
• Input Fields: Input Fields
• Output Fields: Output Fields

Fetch a single Employee in your company by the Id of the Employee.

• ID: get_single_employee_by_id
• Operation: read
• Entities: feedback session, salary, employee
• Summary: This API fetches a single employee in your company by the employee's unique ID. It requires the 'employeeId' as a path parameter, which is a UUID. The API returns detailed information about the employee, including account status, employment status, job data, personal information, compensation details, feedback sessions, and salaries. The response includes a comprehensive JSON object with nested structures for job data, personal data, compensation, feedback, and more. If the employee is found, a 200 status code is returned with the employee details. If the employee or company is not found, a 404 status code is returned. If unauthorized, a 401 status code is returned.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get time off for your company

• ID: get_time_off_for_your_company
• Operation: read
• Entities: time off, company, employee
• Summary: This API retrieves the time off records for a company. It can filter the records by a specified 'from' and/or 'to' date using query parameters. The response includes detailed information about the time off settings and the employees who have registered time off. The response will return a 200 status code with the time off details if found, a 404 status code if no records are found, and a 401 status code if the request is unauthorized.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get your company data

• ID: get_your_company_data
• Operation: read
• Entities: department, company, location
• Summary: The 'Get your company data' API retrieves detailed information about a company, including custom fields for employees and employments, teams, locations, titles, legal entities, and departments. The API does not require any request parameters or body. Upon a successful request (HTTP 200), it returns a JSON object containing arrays of custom fields, teams, locations, titles, legal entities, and departments, each with unique identifiers and names. If the company is not found, a 404 response is returned. If the request is unauthorized, a 401 response is returned.
• Input Fields: Input Fields
• Output Fields: Output Fields

Clock out an employee recordings the employees start time.

• ID: post_clock_out_employee_recordings
• Operation: write
• Entities: recording, time, employee
• Summary: This API is used to clock out an employee by recording their start time. It requires a POST request to the /ClockIn endpoint with a request body containing the employeeId in UUID format. The API does not require any headers, path parameters, or query parameters. The response can be a 200 status if the time off is found, a 401 status if unauthorized, a 404 status if the time off is not found, or a 400 status for a bad request.
• Input Fields: Input Fields
• Output Fields: Output Fields

Import time off from third party program to Hailey

• ID: post_import_time_off_from_third_party_program_to_hailey
• Operation: write
• Entities: employment, time off, employee
• Summary: This API allows importing time off data from a third-party program into Hailey. The request body must include an array of employment time offs, each containing an employeeId, employmentId, and an array of timeOffs. Each time off entry includes a date, timeOffReasonId, scope, and minutes. The API responds with a 201 status code if the import is successful, a 400 status code for bad requests, and a default error response for other issues.
• Input Fields: Input Fields
• Output Fields: Output Fields

Quick add Employee

• ID: post_quick_add_employee
• Operation: write
• Entities: email, company, employee
• Summary: The Quick add Employee API allows for the addition of a new employee to the system. It requires the first name, last name, company email, and start date of the employee in the request body. The API responds with a 201 status code if the employee is successfully added. If the email is invalid, a 400 status code is returned. If the request is unauthorized, a 401 status code is returned. Any other errors will return a default error message.
• Input Fields: Input Fields
• Output Fields: Output Fields