Humi API Directory

Humi HR software is a unified all-in-one human resources information system (HRIS) tailored for Canadian businesses, particularly small to medium-sized enterprises. It offers a comprehensive suite of tools designed to streamline HR processes, making it an invaluable asset for companies looking to enhance their human resources management. By consolidating various HR functions into a single platform, Humi HR software helps businesses manage payroll, HR, benefits, and insurance with ease. Its user-friendly interface and extensive features, such as employee data management, payroll management, and benefits administration, empower organizations to improve efficiency, reduce errors, and save valuable time.

Beyond its core functionalities, Humi HR software excels in providing structured onboarding and offboarding workflows, performance management, compliance and reporting tools, and digital document management. These features ensure that businesses can maintain a high level of organization and compliance while focusing on their growth and development. A key aspect of Humi's appeal is its ability to integrate with other systems through the Humi API, allowing businesses to customize and extend the software's capabilities to meet their unique needs. This flexibility makes Humi HR a versatile solution for modern HR challenges.

Key highlights of Humi HR APIs

Humi offers a Partners API that enables developers to access and manage employee data within third-party applications, facilitating direct integration with the Humi HR platform. This API adheres to the JSON:API specification, ensuring standardized data exchange. Source: GitHub

Key Features of the Humi Partners API:

• Authentication: Utilizes a token-based system. Tokens are included in the Authorization header as a Bearer token for each request.
• Data Format: Employs JSON for both requests and responses, aligning with the JSON:API spec
• Endpoints: Provides access to employee information and time-off data. Key endpoints include:some text
  • Employees:some text
    • List Employees: GET /v1/employees
    • Retrieve Employee Details: GET /v1/employees/{employeeId}
  • Time Off:some text
    • List Time Off Requests: GET /v1/timeoff
    • Retrieve Time Off Details: GET /v1/timeoff/{employeeId}
• Webhooks: Supports event-driven interactions with webhooks for events such as:some text
  • Employee Created
  • Employee Updated
  • Employee Terminated
  • Employee Deleted
  • Company Created
  • Company Updated

‍

Humi HR API Endpoints

Employee

• GET https://partners.humi.ca/v1/employees/:employeeId : Get Employee Details

Payroll

• GET https://partners.humi.ca/v1/payroll/additional_incomes : Get Additional Incomes for a Company
• POST https://partners.humi.ca/v1/payroll/employee_time_worked : Employee Time Worked

Time Off

• GET https://partners.humi.ca/v1/timeoff : Get Approved Time Off Requests
• GET https://partners.humi.ca/v1/timeoff/:employeeId : Get Approved Time Off Requests for Employee

Humi API FAQs

How can I access the Humi HR API?

• Answer: Knit handles the Humi Partners API token request and setup as part of its Humi HR integration, so your team does not have to run this process manually. To access the API directly, you need to obtain a Humi Partners API Token by contacting Humi support at support@humi.ca with the subject "Requesting Humi Partners API Token." This token allows you to access employee data within third-party applications.
  GitHub

What authentication method does the Humi HR API use?

• Answer: Knit's unified API abstracts away Humi's token-based authentication, so you never have to store or rotate a Humi API token yourself. If you connect to Humi directly, the API uses token-based authentication: once you have obtained your API token, include it in the Authorization header of your HTTP requests as Authorization: Bearer your-token-here.

Are there rate limits for the Humi HR API?

• Answer: Knit builds retry logic and error handling into its Humi HR integration, which matters because Humi's official documentation does not specify explicit rate limits. Without a published ceiling, it's recommended that any direct integration implement its own error handling for potential rate-limiting responses to stay reliable.

Can I retrieve employee data using the Humi HR API?

• Answer: Yes, and Knit exposes this same Humi employee data through a single unified schema, so you don't have to build against Humi's endpoints directly. The native Humi HR API provides its own endpoints for this: GET /v1/employees returns a list of employees, and GET /v1/employees/:employeeId retrieves details for a specific employee.

Does the Humi HR API support webhooks for real-time data updates?

• Answer: Yes, and Knit consumes these Humi webhooks on your behalf, delivering normalized real-time updates so you don't have to build separate listeners for each event type. Natively, Humi's API triggers webhooks for events such as EmployeeCreated, EmployeeUpdated, EmployeeTerminated, and EmployeeDeleted, giving your application immediate notification when they occur.

Get Started with Humi API Integration

1. Obtain an API Token: Contact Humi at support@humi.ca to request a Partners API token. Note that the API is in a closed beta phase, and access is provided upon request.
2. Authenticate Requests: Include the obtained token in the Authorization header of your HTTP requests as follows:
   makefile
   Copy code
   Authorization: Bearer your-token-here
3. Make API Calls: Utilize the available endpoints to interact with employee and time-off data. For example, to list employees:
   bash
   Copy code
   GET https://partners.humi.ca/v1/employees
4. Handle Responses: Responses conform to the JSON:API specification, providing structured data for easy parsing and integration.

Additional Resources:

• Sample Node.js Client: A sample Node.js client is available to demonstrate API usage and can serve as a reference for implementation.
• Integration Use Cases: For practical examples of integration scenarios, refer to the Humi-HR API Integration Use Cases, which provide insights into common API interactions. Knit Developers

About Knit

Knit API offers a convenient solution for quick, reliable integration with Humi HR API. Our AI-powered integration platform allows you to build any Humi API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Humi HR API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍