Knit is #1 product of the week in the developer tools category on Product Hunt!
X
Product

Everything you need to know about HRIS API Integration

As organizations grow in revenue and people strength, a lot of data comes into existence that needs to be managed well for business success. With more people being onboarded, most HR teams struggle to manage all processes, especially where employee data is concerned. 

Invariably, different HR tools and software or HRIS (Human Resources Information Software) get adopted to automate certain parts of the workflow. 

Research shows that larger companies with over 500 employees often choose HRIS to consolidate systems. 

With the increasing number of HR tools and overall use cases, organizations need to integrate these software with one another and their core application to ensure seamless flow of information. Here, HRIS integration plays a major role. 

This article seeks to provide a complete understanding on HRIS API integration, focusing on different concepts, data models, use cases and how to achieve it in the most efficient and effective way. 

Key Concepts

Here are some of the key concepts or terminologies you should understand before moving onto more details on the applications, use cases, etc. 

Directory

Directory platforms essentially are the single source of truth for all employees, especially the new joiners. It ensures that when an employee joins, they have access to all the resources, tools and software they need. Employees can leverage the Directory to familiarize themselves with different aspects of the organization. 

Payroll

Payroll refers to everything related to the compensation aspect for employees. It helps companies calculate the salary due to employees at the end of every month, taxes, benefits, etc. It ensures that employees are accurately compensated based on their agreements, while also complying with statutory laws and policies. 

Benefits

In most structured organizations, employees are entitled to additional benefits beyond the compensation. This includes health insurance, accidental insurance, retirement plans, provident fund (India), paid time off, etc. All these come under the benefits section of an employment contract and need to be carefully monitored. 

Recruitment, retention and retirement

Any HRIS API that you come across will address all or some aspects of the employee lifecycle. Here, you should understand the basics of recruitment, which involves attracting and hiring the best talent for your open roles, retention, which focuses on ensuring that you are able to prevent attrition and turnover for your employees by facilitating the right culture, fair pay, etc. and finally, retirement or exit, either due to completion of tenure, age or any other reason. 

Learning and development

Another concept that requires attention is learning and development. It caters to understanding the learning and training needs for your employees, both hard and soft skills and adequately providing the right upskilling opportunities for professional success. 

HRIS Integration: Top Use Cases

Let’s quickly understand how HRIS integration across HR software and tools leads to an exemplary employee experience as well as facilitates operational efficiency for HR teams. Most of the use cases of HRIS integration follow the read and write HRIS APIs which ensure automatic syncing of data between the HRIS platforms and allied applications. Put simply, manually entry of data across applications and updates can be prone to human errors. However, even a single inaccuracy in updating data can lead to serious consequences, including faulty payroll creation, absence tracking, etc. Furthermore, manual data entry might lead to unauthorized data access, especially for sensitive employee information. Here’s a quick snapshot of how HRIS integration can be used across different scenarios.

HRIS integration for ATS tools

ATS or applicant tracking system can leverage HRIS integration to ensure that all important and relevant details about new employees, including name, contact information, demographic and educational backgrounds, etc. are automatically updated into the customer’s preferred HRIS tool without the need to manually entering data, which can lead to inaccuracies and is operationally taxing. ATS tools leverage the write HRIS API and provide data to the HR tools in use.   

Examples: Greenhouse Software, Workable, BambooHR, Lever, Zoho

HRIS integration for payroll software

Payroll software plays an integral role in any company’s HR processes. It focuses on ensuring that everything related to payroll and compensation for employees is accurate and up to date. HRIS integration with payroll software enables the latter to get automated and real time access to employee data including time off, work schedule, shifts undertaken, payments made on behalf of the company, etc. 

At the same time, it gets access to employee data on bank details, tax slabs, etc. Together, this enables the payroll software to deliver accurate payslips to its customers, regarding the latter’s employees. With automated integration, data sync can be prone to errors, which can lead to faulty compensation disbursal and many compliance challenges. HRIS integration, when done right, can alert the payroll software with any new addition to the employee database in real time to ensure setting up of their payroll immediately. At the same time, once payslips are made and salaries are disbursed, payroll software can leverage HRIS integration to write back this data into the HR software for records. 

Examples: Gusto, RUN Powered by ADP, Paylocity, Rippling

HRIS integration for employee onboarding/ offboarding software

Employee onboarding software uses HRIS integration to ensure a smooth onboarding process, free of administrative challenges. Onboarding tools leverage the read HRIS APIs to get access to all the data for new employees to set up their accounts across different platforms, set up payroll, get access to bank details, benefits, etc. With HRIS integrations, employee onboarding software can provide their clients with automated onboarding support without the need to manually retrieve data for each new joiner to set up their systems and accounts. Furthermore, HRIS integration also ensures that when an employee leaves an organization, the update is automatically communicated to the onboarding software to push deprovisioning of the systems, and services. This also ensures that access to any tools, files, or any other confidential access is terminated. Manually deprovisioning access can lead to some manual errors, and even cause delays in exit formalities. 

Examples: Deel, Savvy, Sappling

Ease of communication and announcements

With the right HRIS integration, HR teams can integrate all relevant data and send out communication and key announcements in a centralized manner. HRIS integrations ensure that the announcements reach all employees on the correct contact information without the need for HR teams to individually communicate the needful. 

HRIS integration for LMS tools

LMS tools leverage both the read and write HRIS APIs. On the one hand, they read or get access to all relevant employee data including roles, organizational structure, skills demand, competencies, etc. from the HRIS tool being used. Based on this data, they curate personalized learning and training modules for employees for effective upskilling. Once the training is administered, the LMS tools again leverage HRIS integrations to write data back into the HRIS platform with the status of the training, including whether or not the employee has completed the same, how did they perform, updating new certifications, etc. Such integration ensures that all learning modules align well with employee data and profiles, as well as all training are captured to enhance the employee’s portfolio. 

Example: TalentLMS, 360Learning, Docebo, Google Classroom

HRIS integration for workforce management and scheduling tools 

Similar to LMS, workforce management and scheduling tools utilize both read and write HRIS APIs. The consolidated data and employee profile, detailing their competencies and training undertaken can help workforce management tools suggest the best delegation of work for companies, leading to resource optimization. On the other hand, scheduling tools can feed data automatically with HRIS integration into HR tools about the number of hours employees have worked, their time off, free bandwidth for allocation, shift schedules etc. HRIS integration can help easily sync employee work schedules and roster data to get a clear picture of each employee’s schedule and contribution. 

Examples: QuickBooks Time, When I Work

HRIS integration for benefits administration tools

HRIS integration for benefits administration tools ensures that employees are provided with the benefits accurately, customized to their contribution and set parameters in the organization. Benefits administration tools can automatically connect with the employee data and records of their customers to understand the benefits they are eligible for based on the organizational structure, employment type, etc. They can read employee data to determine the benefits that employees are entitled to. Furthermore, based on employee data, they feed relevant information back into the HR software, which can further be leveraged by payroll software used by the customers to ensure accurate payslip creation. 

Examples: TriNet Zenefits, Rippling, PeopleKeep, Ceridian Dayforce

HRIS integration for workforce planning tools

Workforce planning tools essentially help companies identify the gap in their talent pipeline to create strategic recruitment plans. They help understand the current capabilities to determine future hiring needs. HRIS integration with such tools can help automatically sync the current employee data, with a focus on organizational structure, key competencies, training offered, etc. Such insights can help workforce planning tools accurately manage talent demands for any organization. At the same time, real time sync with data from HR tools ensures that workforce planning can be updated in real time. 

Examples: ClearCompany, Deel, ActivTrak

HRIS API Data Models

The different HRIS tools you use are bound to come with different data models or fields which will capture data for exchange between applications. It is important for HR professionals and those building and managing these integrations to understand these data models, especially to ensure normalization and transformation of data when it moves from one application to another. 

Employees/ Employee Profiles

This includes details of all employees whether full time or contractual, including first and last name, contact details, date of birth, email ID, etc. At the same time, it covers other details on demographics and employment history including status, start date, marital status, gender, etc. In case of a former employee, this field also captures termination date. 

Employee Contact Details

This includes personal details of the employee, including personal phone number, address, etc. which can be used to contact employees beyond work contact information. 

Employee Profile Picture

Employee profile picture object or data model captures the profile picture of the employees that can be used across employee records and purposes. 

Employment Type

The next data model in discussion focuses on the type or the nature of employment. An organization can hire full time employees, contractual workers, gig workers, volunteers, etc. This distinction in employment type helps differentiate between payroll specifications, taxation rules, benefits, etc. 

Location

Location object or data model refers to the geographical area for the employee. Here, both the work location as well as the residential or native/ home location of the employee is captured. This field captures address, country, zip code, etc. 

Leave Request

Leave request data model focuses on capturing all the time off or leave of absence entries made by the employee. It includes detailing the nature of leave, time period, status, reason, etc.

Leave Balance

Each employee, based on their nature of employment, is entitled to certain time off in a year. The leave balance object helps organizations keep a track of the remaining balance of leave of absence left with the employee. With this, organizations can ensure accurate payroll, benefits and compensation. 

Attendance 

This data model captures the attendance of employees, including fields like time in, time out, number of working hours, shift timing, status, break time, etc. 

Organizational Structure

Each organization has a hierarchical structure or layers which depict an employee’s position in the whole scheme of things. The organizational structure object helps understand an employee’s designation, department, manager (s), direct reportees, etc. 

Bank Details

This data model focuses on capturing the bank details of the employee, along with other financial details like a linked account for transfer of salary and other benefits that the employee is entitled to. In addition, it captures routing information like Swift Code, IFSC Code, Branch Code, etc. 

Dependents

Dependents object focuses on the family members of an employee or individuals who the employee has confirmed as dependents for purposes of insurance, family details, etc. This also includes details of employees’ dependents including their date of birth, relation to the employee, among others. 

KYC

This includes the background verification and other details about an employee with some identification proof and KYC (know your customer) documents. This is essential for companies to ensure their employees are well meaning citizens of the country meeting all compliances to work in that location. It captures details like Aadhar Number, PAN Number or unique identification number for the KYC document. 

Compensation

This data model captures all details related to compensation for an employee, including total compensation/ cost to company, compensation split, salary in hand, etc. It also includes details on fixed compensation, variable pay as well as stock options. Compensation object also captures the frequency of salary payment, pay period, etc. 

Unified HRIS API Integration: Get Started

By now, it would be clear to you that there are several HRIS tools in the market today that companies use and need to integrate with one another to ensure smooth exchange of data and consistency in records across platforms. However, manually implementing integrations between APIs of individual platforms can be extremely time consuming and resource intensive. In such a case, you can rely on a unified API like Knit, which gives you a single HRIS API to integrate with. Once you integrate with the HRIS API, you automatically get integrated with all the HR platforms you use. 

Before moving on to the best practices to choose the right Unified HRIS API integration platform, here are some quick reasons why you should choose one:

  • Requires integration with a common unified API to connect with a plethora of HRIS software used by different customers
  • Supports common integration logic, endpoints, pagination which is easy to understand
  • Normalizes and transforms data into a unified data model with possibility of having custom fields for smooth data sync
  • Can facilitate real time data sync between the application offered and HRIS software with instant alerts
  • Tales care of integration maintenance and management with logging and error detection
  • Significantly lower cost and time requirements, ability to integrate with multiple HRIS platforms within days to a few weeks
  • Common documentation and need to understand only one API than toggling between documentation of all HRIS APIs
  • Need to deal with only one form of authentication, rate limits, pagination, etc. 

Here are some points that you should always consider while choosing the right unified HRIS API for your company:

Understand the documentation

Start by gauging whether or not the unified API provides comprehensive and easy to understand documentation for integration. One of the key reasons to choose a unified API is to prevent the effort of navigating through individual documentation for each integration you need. Therefore, getting the right documentation, which covers everything you need is important. The documentation will also help you understand the integration logic being followed, including REST vs SOAP, and end points like  GET, POST, and PATCH, provision of free sandbox, etc. 

Which authentication model is followed?

Next, understand the authentication model that the unified API provides. Essentially, there are a few major types of authentication, including, 

  • Basic Auth that requires an API key or password for access
  • OAuth 2.0 which relies on token exchanges
  • Username-password based authentication

 

The right authentication and authorization is important since it will directly impact the privacy and security of the data you exchange between integrations. 

What are the rate limits?

Rate limits are simply the number of API requests that can be made in a defined period of time. They are generally set to prevent cyber attacks like DDoS attacks which come in the form of exponential unleashing of API requests. Having a lower threshold of rate limit, but with expected high rate of requests can lead to unexpected unified API behavior. Ensure that your unified API provider can customize rate limits to address your and your customer needs.  

Do you get post integration support?

HRIS API integration doesn’t end with building the integrations. There is a lot which goes on once the integrations are under use. There can be errors in data transformation, zombie APIs, API keys breaking or expiring, bad data being returned, long running syncs, troubleshooting challenges, and more. Your unified API needs to provide you with exceptional maintenance and management support, taking care of any challenge that comes along. At the same time, the error messages should be easy to decipher for your customer success team to ultimately address the queries. 

How secure are the integrations?

Undoubtedly, security of your HRIS API integration is critical to your business operations. Thus, choose a unified API provider which is security-first. Gauge the level of encryption it offers, We have already talked about authentication. Don’t forget to check for security protocols, certifications and compliances which are adhered by the unified API for maximum resilience. 

Knit: Unified HRIS API

Knit is a unified HRIS API provider that enables companies to implement native HRIS integrations to streamline and optimize HR processes. When you integrate with Knit, you get:

  • One unified API to connect with all HRIS tools you need
  • Single unified data model for seamless data normalization and exchange
  • Compliance to the highest security standards like SOC2, GDPR, ISO27001, HIPAA
  • Option to authenticate the way you want, including, OAuth, API key or a username-password based authentication
  • 100% webhooks architecture that send out notification whenever updated data is available
  • Guaranteed scalability and delivery of HR data irrespective of data load
  • High level of security as Knit doesn’t store a copy of your data
  • Option to read and write data from any app from any HRIS category
  • Option to limit data sync and API calls to only what you need
  • Double encryption when in transit and when at rest with addition PII layer
  • Detailed Logs, Issues, Integrated Accounts and Syncs page to easily monitor HRIS integrations
  • Custom fields to manage any non-standard HRIS data

Knit, as a unified HRIS API ensures a high ROI for companies which seek to integrate their diverse HRIS applications to make their HR processes effective, without sinking their organizational budgets. 

Wrapping up: TL:DR

To conclude, it is quite evident that HRIS integration is a must have for any growing HR team which is looking to work with several HR tools to manage different parts of the process. However, building and managing integrations in-house can be quite intensive in terms of investments and engineering team involvement. Fortunately, with a unified HRIS API, companies only need to integrate once with a unified API key and connect with all HRIS applications, with high levels of security, guaranteed scalability, seamless data normalization, integration management and real time sync.

Sudeshna Roy

Head of Content, Knit

Decoding product and generating users with valuable content

Latest Blogs

Browse all Blogs
Product
May 26, 2024

Top 5 Finch Alternatives

11
mins

Top 5 Alternatives to tryfinch

TL:DR:

Finch is a leading unified API player, particularly popular for its connectors in the employment systems space, enabling SaaS companies to build 1: many integrations with applications specific to employment operations. This translates to the ease for customers to easily leverage Finch’s unified connector to integrate with multiple applications in HRIS and payroll categories in one go. Invariably, owing to Finch, companies find connecting with their preferred employment applications (HRIS and payroll) seamless, cost-effective, time-efficient, and overall an optimized process. While Finch has the most exhaustive coverage for employment systems, it's not without its downsides - most prominent being the fact that a majority of the connectors offered are what Finch calls “assisted” integrations. Assisted essentially means a human-in-the-loop integration where a person has admin access to your user's data and is manually downloading and uploading the data as and when needed.

Pros and cons of Finch
Why chose Finch (Pros)

● Ability to scale HRIS and payroll integrations quickly

● In-depth data standardization and write-back capabilities

● Simplified onboarding experience within a few steps

However, some of the challenges include(Cons):

● Most integrations are human-assisted instead of being true API integrations

● Integrations only available for employment systems

● Limited flexibility for frontend auth component

● Requires users to take the onus for integration management

Pricing: Starts at $35/connection per month for read only apis; Write APIs for employees, payroll and deductions are available on their scale plan for which you’d have to get in touch with their sales team.

Now let's look at a few alternatives you can consider alongside finch for scaling your integrations

Finch alternative #1: Knit

Knit is a leading alternative to Finch, providing unified APIs across many integration categories, allowing companies to use a single connector to integrate with multiple applications. Here’s a list of features that make Knit a credible alternative to Finch to help you ship and scale your integration journey with its 1:many integration connector:

Pricing: Starts at $2400 Annually

Here’s when you should choose Knit over Finch:

● Wide horizontal and deep vertical coverage: Knit not only provides a deep vertical coverage within the application categories it supports, like Finch, however, it also supports a wider horizontal coverage of applications, higher than that of Finch. In addition to applications within the employment systems category, Knit also supports a unified API for ATS, CRM, e-Signature, Accounting, Communication and more. This means that users can leverage Knit to connect with a wider ecosystem of SaaS applications.

● Events-driven webhook architecture for data sync: Knit has built a 100% events-driven webhook architecture, which ensures data sync in real time. This cannot be accomplished using data sync approaches that require a polling infrastructure. Knit ensures that as soon as data updates happen, they are dispatched to the organization’s data servers, without the need to pull data periodically. In addition, Knit ensures guaranteed scalability and delivery, irrespective of the data load, offering a 99.99% SLA. Thus, it ensures security, scale and resilience for event driven stream processing, with near real time data delivery.

● Data security: Knit is the only unified API provider in the market today that doesn’t store any copy of the customer data at its end. This has been accomplished by ensuring that all data requests that come are pass through in nature, and are not stored in Knit’s servers. This extends security and privacy to the next level, since no data is stored in Knit’s servers, the data is not vulnerable to unauthorized access to any third party. This makes convincing customers about the security potential of the application easier and faster.

● Custom data models: While Knit provides a unified and standardized model for building and managing integrations, it comes with various customization capabilities as well. First, it supports custom data models. This ensures that users are able to map custom data fields, which may not be supported by unified data models. Users can access and map all data fields and manage them directly from the dashboard without writing a single line of code. These DIY dashboards for non-standard data fields can easily be managed by frontline CX teams and don’t require engineering expertise.  

● Sync when needed: Knit allows users to limit data sync and API calls as per the need. Users can set filters to sync only targeted data which is needed, instead of syncing all updated data, saving network and storage costs. At the same time, they can control the sync frequency to start, pause or stop sync as per the need.

● Ongoing integration management: Knit’s integration dashboard provides comprehensive capabilities. In addition to offering RCA and resolution, Knit plays a proactive role in identifying and fixing integration issues before a customer can report it. Knit ensures complete visibility into the integration activity, including the ability to identify which records were synced, ability to rerun syncs etc.

As an alternative to Finch, Knit ensures:

● No-Human in the loop integrations

● No need for maintaining any additional polling infrastructure

● Real time data sync, irrespective of data load, with guaranteed scalability and delivery

● Complete visibility into integration activity and proactive issue identification and resolution

● No storage of customer data on Knit’s servers

● Custom data models, sync frequency, and auth component for greater flexibility

Finch alternative #2: Merge

Another leading contender in the Finch alternative for API integration is Merge. One of the key reasons customers choose Merge over Finch is the diversity of integration categories it supports.

Pricing: Starts at $7800/ year and goes up to $55K

Why you should consider Merge to ship SaaS integrations:

● Higher number of unified API categories; Merge supports 7 unified API categories, whereas Finch only offers integrations for employment systems

● Supports API-based integrations and doesn’t focus only on assisted integrations (as is the case for Finch), as the latter can compromise customer’s PII data

● Facilitates data sync at a higher frequency as compared to Finch; Merge ensures daily if not hourly syncs, whereas Finch can take as much as 2 weeks for data sync

However, you may want to consider the following gaps before choosing Merge:

● Requires a polling infrastructure that the user needs to manage for data syncs

● Limited flexibility in case of auth component to customize customer frontend to make it similar to the overall application experience

● Webhooks based data sync doesn’t guarantee scale and data delivery

Finch alternative #3: Workato

Workato is considered another alternative to Finch, albeit in the traditional and embedded iPaaS category.

Pricing: Pricing is available on request based on workspace requirement; Demo and free trial available

Why you should consider Workato to ship SaaS integrations:

● Supports 1200+ pre-built connectors, across CRM, HRIS, ticketing and machine learning models, facilitating companies to scale integrations extremely fast and in a resource efficient manner

● Helps build internal integrations, API endpoints and workflow applications, in addition to customer-facing integrations; co-pilot can help build workflow automation better

● Facilitates building interactive workflow automations with Slack, Microsoft Teams, with its customizable platform bot, Workbot

However, there are some points you should consider before going with Workato:

● Lacks an intuitive or robust tool to help identify, diagnose and resolve issues with customer-facing integrations themselves i.e., error tracing and remediation is difficult

● Doesn’t offer sandboxing for building and testing integrations

● Limited ability to handle large, complex enterprise integrations

Finch alternative #4: Paragon

Paragon is another embedded iPaaS that companies have been using to power their integrations as an alternative to Finch.

Pricing: Pricing is available on request based on workspace requirement;

Why you should consider Paragon to ship SaaS integrations:

● Significant reduction in production time and resources required for building integrations, leading to faster time to market

● Fully managed authentication, set under full sets of penetration and testing to secure customers’ data and credentials; managed on-premise deployment to support strictest security requirements

● Provides a fully white-labeled and native-modal UI, in-app integration catalog and headless SDK to support custom UI

However, a few points need to be paid attention to, before making a final choice for Paragon:

● Requires technical knowledge and engineering involvement to custom-code solutions or custom logic to catch and debug errors

● Requires building one integration at a time, and requires engineering to build each integration, reducing the pace of integration, hindering scalability

● Limited UI/UI customization capabilities

Finch alternative #5: Tray.io

Tray.io provides integration and automation capabilities, in addition to being an embedded iPaaS to support API integration.

Pricing: Supports unlimited workflows and usage-based pricing across different tiers starting from 3 workspaces; pricing is based on the plan, usage and add-ons

Why you should consider Tary.io to ship SaaS integrations:

● Supports multiple pre-built integrations and automation templates for different use cases

● Helps build and manage API endpoints and support internal integration use cases in addition to product integrations

● Provides Merlin AI which is an autonomous agent to build automations via chat interface, without the need to write code

However, Tray.io has a few limitations that users need to be aware of:

● Difficult to scale at speed as it requires building one integration at a time and even requires technical expertise

● Data normalization capabilities are rather limited, with additional resources needed for data mapping and transformation

● Limited backend visibility with no access to third-party sandboxes

TL:DR

We have talked about the different providers through which companies can build and ship API integrations, including, unified API, embedded iPaaS, etc. These are all credible alternatives to Finch with diverse strengths, suitable for different use cases. Undoubtedly, the number of integrations supported within employment systems by Finch is quite large, there are other gaps which these alternatives seek to bridge:

Knit: Providing unified apis for different categories, supporting both read and write use cases. A great alternative which doesn’t require a polling infrastructure for data sync (as it has a 100% webhooks based architecture), and also supports in-depth integration management with the ability to rerun syncs and track when records were synced.

Merge: Provides a greater coverage for different integration categories and supports data sync at a higher frequency than Finch, but still requires maintaining a polling infrastructure and limited auth customization.

Workato: Supports a rich catalog of pre-built connectors and can also be used for building and maintaining internal integrations. However, it lacks intuitive error tracing and remediation.

Paragon: Fully managed authentication and fully white labeled UI, but requires technical knowledge and engineering involvement to write custom codes.

Tray.io: Supports multiple pre-built integrations and automation templates and even helps in building and managing API endpoints. But, requires building one integration at a time with limited data normalization capabilities.

Thus, consider the following while choosing a Finch alternative for your SaaS integrations:

● Support for both read and write use-cases

● Security both in terms of data storage and access to data to team members

● Pricing framework, i.e., if it supports usage-based, API call-based, user based, etc.

● Features needed and the speed and scope to scale (1:many and number of integrations supported)

Depending on your requirements, you can choose an alternative which offers a greater number of API categories, higher security measurements, data sync (almost in real time) and normalization, but with customization capabilities.

API Directory
Apr 9, 2024

A Guide toIntegrating with Freshteams API

11
mins

Freshteam API Directory

A cloud based HR software, Freshteam enables organizations with managing employee details, recruitment, on-boarding, time-off, off-boarding, and organization details, among other aspects of their HR processes and practices. With Freshteam API integration, organizations can seamlessly synchronize data between their application and Freshteam to ensure real time updation of employee information across both platforms. It helps capture any changes in employee status, designation, HR policies, etc. across different applications a business uses. 

Freshteam API Authentication, Filtering, Rate Limits

To ensure utmost security and prevent unauthorized access, Freshteam API uses Oauth2.0 for authentication and authorization. Developers can use the Freshteam UI to make calls to the Freshteam authentication server to obtain an access token. This access token can be used to make valid API calls thereon. The access token identifies the requester and the requester’s permission. In the Freshteam domain, the access token is present under Your API Key, which can be copied and used to make API calls. 

Rate limits i.e. the number of API calls that can be made in a minute for Fresteam API are determined by the plan selected by the organization. The rate limit variation for each plan is dependent on the number of subscribed employees for the organization. The trial account has a limit of 10 API calls per minute, which goes on to as high as (100, 2 * number of subscribed employees) API calls per minute for the enterprise plan. Developers or admins can also keep a track of the API calls to understand their usage patterns via:

  • X-ratelimit-total: Permissible number of API calls in a minute.
  • X-ratelimit-remaining: Number of API calls remaining.
  • X-ratelimit-used-currentrequest: Number of API calls consumed by the API request that obtained the response.

There are several endpoints in Freshteam API which retrieve bulk data, especially the ones which are required to List a certain object. In such a case, developers can use pagination parameters to filter data and limit the responses for a streamlined understanding. Developers can select the page value (from which page number they want responses), as well as the number of responses required for each page (default is set at 50). They can also sort the values as ascending or descending or select some other attribute for sorting as well. 

Freshteam API Objects, Data Models & Endpoints

Employees

  • List all employees: GET /employees
  • Create an employee: POST /employees
  • Retrieve employee information: GET /employees/{id}
  • Update employee information: PUT /employees/{id}
  • List all employee fields: GET /employee_fields
  • Create a custom employee field: POST /employee_fields

Common attributes: id, created at, updated at, workstation number, date of birth, gender, address, communication address, designation, phone number, joining date, termination date, first name, last name, status, official email, personal email, employee type, team id, department id, reporting to id, time off, hire reason, marital status, etc. 

Branches

(Used to configure different geographical locations for an organization and associate employees to a branch)

  • List all branches: GET /branches

Common attributes: id, created at, updated at, name, street, state, country code, zip, time zone, currency, language, main office, date format

Departments & Sub-Departments

  • List all departments: GET /departments
  • List all sub-departments: GET /sub_departments

Business Units

  • List all business units: GET /business_units

Common attributes: id, created at, updated at, name, description

Teams

  • List all teams: GET /teams

Levels

  • List all levels: GET /levels

Timeoffs

  • List all timeoffs: GET /time_offs
  • Create a timeoff request: POST /time_offs
  • List all timeoff types: GET /time_off_types
  • Retrieve timeoff information: GET /time_off_types/{id}
  • Cancel A Timeoff Request: PUT /time_off_types/{id}/ cancel
  • Approve A Timeoff Request: PUT /time_off_types/{id}/ approve

Common attributes: id, created at, updated at, start date, end date, status, leave units, leave type id, status comments, comments, attachment, applied by, approved by, rejected by, canceled by, notify to, description, add to calendar, canceled at, optional leave days, applicable for, auto approve, status

Roles

  • List all roles: GET /roles

Job Postings

  • List all job postings: GET /job_postings
  • Retrieve job posting information: GET /job_postings/{id}
  • List all job posting fields: GET /job_posting_fields
  • List all applicant fields: GET /job_postings/{id}/applicant_fields
  • Create an applicant: POST  /job_postings/{id}/applicants

Common attributes: id, created at, updated at, deleted, title, description, status, show_pursue_as_career, closing date, experience, remote, type, salary, branch, department, title, location, skills, requisitions, label, field type, position, candidate, candidate id, first name, last name, date of birth, mobile, phone number, source id, resume, cover letter, portfolio, skype id, content file name, url, gender, profile link, rejected at, archived at, on hold at, on hold till

Candidate Sources

  • List all candidate sources: GET /candidate_sources
  • Create a candidate source: POST /candidate_sources
  • List all candidate source categories: GET ​/candidate_source_categories

Common attributes: id, created at, updated at, deleted, label, default, leads count

User Functions

  • List all user functions: GET /user_functions

New Hires

  • Create a new hire: POST /new_hires
  • Retrieve new hire information: GET /new_hires/{id}
  • Update new hire information: PUT /new_hires/{id}

Common attributes: id, created at, updated at, deleted, first name, middle name, last name, official email, employee id, status, workstation number, designation, joining date, probation start date, probation end date, branch id, team id, department id, sub department id, termination date, termination reason, notice period, notice start date, notice end date, employee type, hired on, no show, no show reason, date of birth, marital status, gender, blood group, emergency contacts, social profiles, address, communication address, phone numbers, job codes, job exempt, scheduled weekly hours, retirement eligibility date, rehire eligibility, rehire status, confirmed, language, branch, team

Freshteam API Use Cases

  • Centralize HR operations with AI-powered virtual agents, self-service solutions and  seamless integration with MS Teams, Slack, and other applications
  • Automate internal processes with easy-to-configure workflows, leading to streamlined work and increased efficiency
  • Leverage 50+ job descriptions out of the box for use to accelerate hiring processes
  • Capture qualitative feedback about candidates along with better candidate relationships through built-in email and a manageable candidate database

Top customers

50,000+ companies from across 120+ countries use Freshteam to power their HR operations and streamline processes to make them efficient, robust and optimized. Here are some of the top customers that are leveraging Freshteam:

  • Gartner, Inc., an American technological research and consulting firm
  • OpeninApp, a smart link generator tool that ensures all social media links open in the apps they should
  • Dymocks Booksellers, an Australian-founded privately owned bookstore chain
  • Valley Medical Center, a 321-bed, acute care community hospital and clinic network
  • Kirat Plastics, a full-service custom plastic injection molding, metal pressing, fabrication, and assembly facility
  • Lot Squared Development, a Washington DC based design-build residential real estate developer 

Freshteam API FAQs

Here is a list of Freshteam API FAQs that developers must understand to make their integration journey more effective and robust:

  • How to use Freshteam Developer API? Answer
  • Where to find Freshteam API key, how to reset it and Scope of an API Key? Answer
  • What are the status and error messages that indicate the success or failure of an API request in Freshteam API? Answer
  • What are the common request header parameters used in requests to Freshteam APIs? Answer
  • What are the API methods that developers interact with for Freshteam API? Answer
  • What are models in Freshteam API? Answer

Common Integrations with Freshteam API 

Businesses, especially those engaged in the employee side of work, are increasingly seeking integration with Freshteam API to streamline data exchange between this HRIS platform and their application. Some of the top use cases and common integrations with Freshteam API include:

  • Recruitment companies which can use the write APIs to update candidate information into Freshteam once a client is hired to ensure the customer’s HRIS is up to date for all onboarding and future requirements
  • Payroll providers can leverage both read APIs to fetch employee information for payroll creation and disbursement, as well as write APIs, to push back data into customer’s Freshteam account to notify that salaries have been paid
  • Rewards and recognition companies which can use integration with Freshteam API to fetch information on employees to seamlessly manage their operations and help end customers build a culture of recognition.  

How to integrate with Freshteam API 

To kickstart the integration journey with Freshteam API, developers can go through this quick start guide. The first step is to create a developer account and join the Freshteam developer community. Next developers need to follow the installation instructions to install the API SDK. Following this it is important to get acquainted with the authorization and authentication protocols to access data and make API calls.  Learn about the terms of use for accessing or using the Freshteam developer portal and understand the different terminology used. For more support and information, businesses can scroll through the Freshteam support page and get answers to their queries. 

Get started with Freshteam API 

Companies that integrate with Freshteam API benefit from the seamless exchange of information between this HRIS platform and their application and have been able to explore multiple use cases for their end customers. However, manually building and maintaining integration with Freshteam API can be a daunting task for developers. Building the integration alone can take 4 weeks on an average and cost USD 10K (considering the cost of software developers, QA engineers, etc.). Further, the cost associated with maintaining the Freshteam API adds another burden on the bottom line, while diverting resources away from core product functionalities and enhancements. And, this is for a single HRIS integration in question here (Freshteam API). Businesses generally need to integrate with multiple HRIS APIs, meeting the demands of their end customers. Here, a unified HRIS API like Knit can enable businesses to easily integrate with multiple HRIS applications with a single connector. By incorporating an additional layer of abstraction, a unified API allows businesses to ship and scale integrations faster and in an efficient manner. Book a discovery call today to learn how developers can integrate with Freshteam API and other HRIS applications within hours and not weeks. 

API Directory
Apr 9, 2024

A Guide to Integrating with Zenefits APIs

11
mins

Zenefits API Directory

TriNet Zenefits is a leading provider of full service HR solutions. It enables small and medium sized companies to administer and manage benefits, HR offerings, including time tracking, onboarding, employee engagement, employee record keeping; payroll; performance and well-being. As a highly sought after HRIS platform, companies have been increasingly integrating with TriNet Zenefits to facilitate seamless exchange of HRIS data, captured by Zenefits, with their own apps to drive diverse use cases. 

Zenefits API Authentication, Filtering, Rate Limits

Owing to the sensitive nature of information held by the HRIS application, including personal identifiable information (PII), Zenefits API ensures that all data scopes are accessed at a granular level. The Zenefits API uses OAuth2 to authenticate and authorize access to information stored in the application. OAuth2 authorizes third party applications to request private details from Zenefits accounts, without passwords. It is limited only to admins and developers receive unique Client ID and Client Secret to access data with integration. 

Zenefits API pagination helps developers define the records needed per page. The developers can use the limit parameter to specify the number of records in a response. The maximum limit can be 100, however, in case the limit is not defined, the default limit is 20. In case the total number of records do not fit into a single page, the next_url field will have a link to the next page with the remaining records. In case the next_url field displays null, then no records exist for subsequent pages. Developers can also use the starting_after or ending_before query parameter to specify pagination based on object ids. The ending_before query parameter is useful for backwards pagination. 

Zenefits API Objects, Data Models & Endpoints

It is extremely important for developers to understand the objects, data models and endpoints when it comes to integrating with Zenefits API. While the overall scope might be large, here are a few which can be considered as a starting point for Zenefits API integration. 

  • Applications: Used to return information about the application

GET https://api.zenefits.com/platform/applications

  • Companies: Used to get information about the company

GET https://api.zenefits.com/core/companies

Fields include: ‘legal_name', 'ein','departments', 'locations'

  • People: Used to return information about a company’s employees

GET https://api.zenefits.com/core/companies/{:company_id}/people

GET http://api.zenefits.com/core/people/{:id} (For information about a single employee)

GET http://api.zenefits.com/core/people (For information for all employees across the company)

Fields include: 'work_email', 'date_of_birth', 'manager', 'department', 'location', 'work_phone', 'status', 'subordinates', 'banks','company', 'employments', 'department', 'location', 'manager', 'banks'

  • Employments: Used to return information about an employee’s employment history

GET https://api.zenefits.com/core/people/{:person_id}/employments

GET https://api.zenefits.com/core/employments/{:employment_id} (For information on a specific employment

GET https://api.zenefits.com/core/employments (For information on all employments across all people)

Fields include: 'termination_type', 'employment_type', 'comp_type', 'annual_salary', 'pay_rate', 'working_hours_per_week','person'

  • Employee Bank Accounts: Used to return information about employee’s bank account

GET https://api.zenefits.com/core/people/{:person_id}/banks

GET http://api.zenefits.com/core/banks/{:bank_id} (For information for a specific bank)

GET http://api.zenefits.com/core/banks (For information for all banks across all people)

  • Departments: Used to return the list of a company’s department

GET https://api.zenefits.com/core/companies/{:id}/departments

GET http://api.zenefits.com/core/departments/{:department_id} (For information regarding a single department:

GET http://api.zenefits.com/core/departments (For information relating to all departments across all companies)

  • Locations: Used to return the list of a company’s location

GET https://api.zenefits.com/core/companies/{:company_id}/locations

GET http://api.zenefits.com/core/locations/{:location_id} (For information relating to a single location)

GET http://api.zenefits.com/core/locations (For information relating to all locations across all companies)

  • Vacation Requests: Used to return information about employees' PTO vacation requests

GET https://api.zenefits.com/time_off/vacation_requests

GET http://api.zenefits.com/time_off/vacation_requests/{:id} (For information relating to a single vacation request)

GET http://api.zenefits.com/time_off/vacation_types/{:vacation_type_id}/vacation_requests/ (For all vacation requests for a single vacation type)

Fields include: 

  • status: Requested, approved, denied, cancelled, deleted
  • vacation_type: Vacation Type for this request, e.g. Jury Duty, Work From Home, Doctor's Appointment
  • start_date: Start date of vacation request (inclusive)
  • end_date: End date of vacation request (inclusive) 
  • creator i.e. Person who filed this vacation request
  • person i.e. Person who this vacation request applies to (often the same as creator)
  • created_date: Date this vacation request was created
  • hours: Number of hours requested, generally calculated at 8 hours a day for multi-day requests and specified manually for single day requests
  • approved_date: Date this request was moved from requested status, either to approved or denied.
  • reason: Note from the person requesting this vacation
  • deny_reason: Note from the approver for why this vacation request was denied. (Only applies if status is denied)

  • Vacation Types: Used to return information about a company's PTO vacation types

GET https://api.zenefits.com/time_off/vacation_types 

GET http://api.zenefits.com/time_off/vacation_types/{:id} (For information relating to a single vacation type)

Fields include:

  • status: Active, deleted
  • vacation_types
  • name: Name of the type
  • company: Company for this vacation type
  • vacation_requests: Vacation Requests for this type
  • counts_as: What account this type counts towards (vacation, sick, personal)

  • Time Durations: Used to return information about a person's T&A hours

GET https://api.zenefits.com/time_attendance/time_durations

GET http://api.zenefits.com/time_attendance/time_durations/{:id} (For information relating to a single time duration object)

Fields include: 

  • person: Person that this time duration is logged for people
  • activity: Activity type (work, meal_break)
  • state: Effective, overridden, deleted, correction
  • valid_status: valid, exceeds, overlapping same day, overlapping previous day, overlapping next day, missing clock out, missing clock in
  • hours: Number of hours logged
  • start: When this time duration started
  • end: When this time duration ended
  • is_overnight: Whether this time duration has been marked as part of an overnight shift
  • is_approved: When this time duration was approved. 
  • approver: Person who approved this time duration

Zenefits API Use Cases

  • Automate onboarding, saving 100s of hours as information gets auto synced to Benefits and Payroll
  • Simplify employee management with organizational charts, company directories allowing employees to update their own records
  • Improve HR processes and decision making with business intelligence reports and insights on turnover, workforce diversity, with understanding of how to pay new hires
  • Simplify the process of providing great benefits to employees, from comprehensive healthcare plans to extra perks like commuter benefits
  • Facilitate time and attendance management with employee scheduling tools, with time off and clocked-in hours automatically syncing Payroll

Zenefits API FAQs

Here is a list of FAQs about TriNet Zenefits API which can help commence and accelerate your integration:

  • What is the software stack of Zenefits? Answer
  • How to address the CORS issue in Angular 8 without changing the backend in Zenefits API? Answer 
  • How to handle New Company Installations in TriNet Zenefits API? Answer
  • How to handle New People's Subscriptions in TriNet Zenefits API? Answer
  • What does Webhooks shared secret vs OAuth client secret mean? Answer
  • How to read and write custom data with Zenefits API? Answer
  • How to issue Access Tokens for Zenefits API authentication and authorization? Answer
  • Where can I find a guidebook for Zenefits integration? Answer
  • Does Zenefits have a public API? Answer
  • What is Zenefits’ App Acceptance Criteria for API integration? Answer
  • Where is the developer portal for Zenefits API? Answer

Common Integrations with Zenefits API 

Several businesses are increasingly building integrations with Zenefits API to power operations for the end customers, facilitated by seamless data exchange, including:

  • Payroll providers to get access to employee information, employment records and agreement terms, compensation details and other relevant information like leaves, time off, etc. 
  • Candidate recruitment companies to push data about selected candidates and relevant information for smooth onboarding
  • Employee engagement companies to fetch employee data, including demographic information, personal and professional details, attendance, etc. 
  • Early wage access providers to get access to employee information, payroll details and even write back data regarding early payments/ deductions for accurate payroll processing

How to integrate with Zenefits API 

To get started with the Zenefit API integration journey, a developer account needs to be created. To create the same, developers can reach out to Zenefits team by dropping an email on this email address. Reaching out on this email ID will take the developers to the next step to get access to a sandboxed Zenefits test company and credentials to start using the API. Once the Zenefits developer account is active, developers can leverage this getting started guide for a detailed overview on REST API, Modules, Webhooks, Authentication and much more.  It is important to read through and understand the App Acceptance Criteria well. The same can be accessed here. At the same time, knowledge of the Zenefits Developer Policy is critical to understand the technical, brand and general requirements and restrictions. 

Get started with Zenefits API 

Integrating with Zenefits API is beneficial for businesses looking to seamlessly exchange data with this leading HRIS provider with bi-directional sync. However, building a custom 1:1 integration can be a complex, time and resource intensive process. The above mentioned steps, restrictions and requirements can all choke up developer bandwidth. Invariably, SaaS businesses today are moving away from building integrations to partnering with unified APIs like Knit. A unified API, in this case for HRIS integrations, enables companies to integrate once and seamlessly connect with multiple HRIS applications, including Zenefits API, without any additional requirements. With a unified HRIS API, maintenance and management of integration with Zenefits and other applications also becomes quite easy. Book a discovery call today to learn how a unified API can help you ship and scale integrations fast. 

Start building with Knit, today

Talk to our sales team for a free tour of Knit!

Book Demo!