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

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 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 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. 


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 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. 


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 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. 


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. 


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
API Directory
Feb 26, 2024

greytHR API Guide


greytHR API Directory

greytHR is a leading HR and Payroll software provider for small and medium sized companies. It enables HR teams and professionals to automate all people operations including employee information management, leave and attendance management, training, appraisals, compensation, etc. greytHR API enables developers to access HR related information like Employee/Leave/Attendance/Salary for seamless exchange between different applications. 

greytHR API Authentication

greytHR is based on oAuth2 based authentication for access to APIs, which is an industry-standard protocol for authorization. Since the greytHR API captures a lot of sensitive and confidential information, only authorized entities get access to it. Each API request is authenticated with an auth-token using the client id and client credentials obtained during the registration process. A verified username and password is used for basic authentication. 

greytHR API API Objects, Data Models & Endpoints

If you are working with greytHR API for integration with other applications, it is important to understand the data models, objects and endpoints to facilitate data normalization and accurate API requests. Some of these are captured below to help you get started. 


  • GET Get all Employees: 
  • GET Get Employee:{employee-id}
  • GET Employee Lookup:{EmployeeNo./Email/Guid/Access card/ Personal email}
  • POST Add Employee:
  • PUT Update Employee:{employee-id}
  • GET Get All Employee Profile Details:
  • GET GET All employees Photo:
  • GET Get Employee Photo:{employeeId}/photo
  • GET Get Employee Profile Details:{employee-id}/profile
  • PUT Update Employee Profile Details:{employee-id}/profile
  • GET Get All Employee Personal Details:
  • GET Get Employee Personal Details:{employee-id}/personal
  • PUT Update Employee Personal Details:{employee-id}/personal
  • GET Get All Employee Work Details:
  • GET Get Employee Work Details Copy:{employee-id}/work
  • PUT Update Employee Work Details:{employee-id}/work
  • GET Get All Employee Separation Details:
  • GET Get Employee Separation Details Copy:{employee-id}/separation
  • PUT Update Employee Separation Details:{employee-id}/separation
  • GET Get All Employee Address Details:{address-type}
  • GET Get Employee Address Details:{employee-id}/addresses/{address-type}
  • PUT Update Employee Address Details:{employee-id}/addresses/{address-type}
  • DELETE Delete Employee Address Details:{employee-id}/addresses/{address-type}
  • GET Get All Employee Statutory Details:
  • GET Get Employee Statutory Details:{employee-id}/statutory/india
  • PUT Update Employee Statutory Details:{employee-id}/statutory/india
  • GET Get Orgtree - Reporting Structure:
  • GET Get Employee Manager details:{employee-id}/org-tree
  • POST Add Employee Manager:{employee-id}/org-tree
  • PUT Update Employee Manager:{employee-id}/org-tree
  • GET Get All Employee Positions details:
  • GET Get Employee Positions Details:{employee-id}/categories
  • POST Add Employee Positions:{employee-id}/categories
  • GET Get All Employee Bank Details:
  • GET Get Employee Bank Details:{employee-id}/bank
  • POST Add Employee Bank Details:{employee-id}/bank
  • PUT Update Employee Bank Details:{employee-id}/bank
  • GET Get All Employee PF & ESI details:
  • GET Get Employee PF & ESI details:{employee-id}/pf
  • POST Add Employee PF & ESI details:{employee-id}/pf
  • PUT Update Employee PF & ESI details:{employee-id}/pf
  • GET Get Employee's All Identity Details:{employee-id}/identities
  • GET Get Employee Identity Details:{employee-id}/identities/{identity-code}
  • POST Add Employee Identity:{employee-id}/identities/{identity-code}
  • PUT Update Employee Identity:{employee-id}/identities/{identity-code}
  • DELETE Delete Employee Identity:{employee-id}/identities/{identity-code}
  • GET Get Employees Family Details:{relationtype-id}
  • GET Get Employee Family Details:{employee-id}/families
  • POST Add family member to Employee:{employee-id}/families
  • PUT Update Family member details:{employee-id}/families/{relation-id}
  • DELETE Delete Family member details:{employee-id}/families/{relation-id}
  • GET Get All Employee Asset details:
  • GET Get Employee Asset details:{employee-id}/assets
  • POST Add Asset to Employee:{employee-id}/assets
  • POST Add Asset to Employee:{employee-id}/assets
  • DELETE Delete Update Family member details:{employee-id}/assets/{asset-id}
  • GET Get All Employee Qualifications details:
  • GET Get Employee Qualifications details:{employee-id}/qualifications
  • POST Add Employee Qualifications:{employee-id}/qualifications
  • PUT Update Employee Qualifications details:{employee-id}/qualifications/{qualification-id}
  • DELETE Delete Employee Qualifications details:{employee-id}/qualifications/{qualification-id}
  • GET Get Employee All Card Details:{employeeId}/card-details
  • GET Get Employee Card Details:
  • POST Add Employee Card Details:{employeeId}/card-details
  • DELETE Delete Employee Card Details:{employeeId}/card-details/{cardId}


  • GET Get Leave Balance details for All Employees:{{Year}}/balance
  • GET Get Employee Leave Balance for a year:{employee-id}/years/{{Year}}/balance
  • GET Get Leave Transactions details for All Employees:{{StartDate}}&end={{EndDate}}
  • GET Get Employee Leave Transactions:{employee-id}/transactions?start={{StartDate}}&end={{EndDate}}
  • POST Leave Transaction:


  • GET Get Attendance Summary for All Employees:{{EndDate}}&start={{StartDate}}
  • GET Get Employee Attendance Summary:{employee-id}/insights?end={{EndDate}}&start={{StartDate}}
  • GET Get Employee Attendance Summary:{employee-id}/insights?end={{EndDate}}&start={{StartDate}}
  • GET Get Employee Attendance Muster:{employee-id}/muster?end={{EndDate}}&start={{StartDate}}


  • GET Get All Employee Handenrty salary Items:
  • GET Get Employee Handenrty salary Items:{employee-id}
  • GET Get Salary Repository Items:
  • POST Add Employee Handenrty salary Items:{employee-id}
  • PUT Update Employee Handenrty salary Items:{employee-id}
  • DELETE Delete Employee Handenrty salary Items:{employee-id}
  • GET Get Salary Statement for a Month:{{yyyy-mm-01}}
  • GET Get Salary Statement for an Employee for a Month:{{yyyy-mm-01}}/{employee-id}
  • GET Get Employees Resettlement for a Month:{payrollMonth}
  • POST Add Salary Revision:{employee-id}
  • GET Get Salary Revision History:{employee-id}/{status}
  • GET Get Salary Revision Difference:{employee-id}
  • GET Get Attendance Snapshot details:{employee-id}
  • POST Save Attendance Snapshot:{employee-id}
  • DELETE Delete Attendance Snapshot:{employee-id}

List of Values

  • POST Get greytHR LOV:
  • POST Get greytHR Position/Category:
  • GET Get Bank Branch Details:{bankId}/branches
  • POST Add greytHR Org Entities:


  • GET Get Employee Documents:{employeeId}/{categoryId}
  • GET Download Employee Documents:{employeeId}/{documentId}/{fieId}
  • POST Add Employee Document Category:
  • POST Add Employee Document:{employeeId}/{category}


  • POST Add New Users:
  • GET Get Users List:
  • GET Get Employee User ID: Number
  • POST User SSO:{userid}/auth

greytHR API Use Cases 

  • Centralized employee information management and simplification of HR processes by eliminating inconsistencies, duplication and clutter in employee information
  • Easy payroll management with accurate and timely payouts
  • Seamless leave management with accurate leave accounting and integration with payroll
  • Real time attendance management, easy shift and overtime management
  • Goal alignment and performance management, progress tracking, rewards achievements

Top customers

greytHR provides HRMS services to 20,000+ companies across 250+ cities, including:

  • Dunzo, a 24x7 delivery app
  • HealthifyMe, an Indian digital health and wellness company
  • Rapido, an Indian ride-hailing service
  • Hutchinson, a French manufacturer of non-tire rubber
  • Lentra, a new-age domain-native platform 
  • ClickDesk, a live support chat software 
  • CORE Energy Systems, an emerging engineering services and project management company

greytHR API FAQs

  • How can admin enable the role for API users? Answer
  • How to generate API credentials for the greytHR admins? Answer
  • Is it possible to configure API credentials in Tally without enabling the integration of greytHR? Answer

How to integrate with greytHR API 

To integrate with the greytHR API, you need to create an account. You can create an account here. You can then go through this documentation to understand the REST API for external applications to integrate and interoperate with greytHR. 

Get started with greytHR API 

greytHR offers a freemium model for its users. While some features for a certain number of employees can be availed free of cost, the paid version starts at ₹3495/month adding more features which users can leverage. There are more premium tiers to choose from. Each pricing plan comes with a free trial. 

However, integrating with greytHR API with in-house resources can be quite expensive and time consuming, for both building and managing the integration. You can significantly bring this cost down by partnering with a platform like Knit. With a nominal integration cost, Knit helps you integrate with a unified HRIS API, with which you can connect with its bouquet of HRIS applications, including greytHR, at no additional cost. As a unified API, Knit helps you connect with your preferred HRIS applications in a fraction of the cost and time. Book a demo today to learn more! 

API Directory
Feb 26, 2024

Zoho People API Guide


Zoho People API Directory

Zoho People is a leading HR solution provider which enables companies to automate and simplify their HR operations. Right from streamlining core HR processes, to supporting time and attendance management, to facilitating better performance management and fostering greater learning and development, Zoho People has been transforming HR operations for 4500+ companies for over a decade. 

With Zoho People API, companies can seamlessly extract and access employee data, update it and integrate this application with other third party applications like ATS, LMS, employee onboarding tools, etc. to facilitate easy exchange of information. 

Zoho People API Authentication

Like most industry leading HRIS applications, Zoho People API uses OAuth2.0 protocol for authentication. The application leverages Authorization Code Grant Type to obtain the grant token(code), allowing users to share specific data with applications, without sharing user credentials. Zoho People API uses access tokens for secure and temporary access which is used by the applications to make requests to the connected app. 

Using OAuth2.0, Zoho People API users can revoke a customer's access to the application at any time, prevent disclosure of any credentials, ensure information safeguarding if the client is hacked as access tokens are issued to individual applications, facilitate application of specific scopes to either restrict or provide access to certain data for the client.

Zoho People API Objects, Data Models & Endpoints

Integrating with any HRIS application requires the knowledge and understanding of the objects, data models and endpoints it uses. Here is a list of the key concepts about Zoho People API which SaaS developers must familiarize themselves with before commencing the integration process. 

Forms API

  • POSTInsert Record API<inputType>/<formLinkName>/insertRecord?inputData=<inputData>

  • POSTInsert Record API for Adding Employees<inputData>

  • POSTUpdate Record API<inputType>/<formLinkName>/updateRecord?inputData=<inputData>&recordId=<recordId>

  • GETGet Bulk Records API<formLinkName>/getRecords?sIndex=<record starting index>&limit=<maximum record to fetch>​

  • POSTAdd Department API<xmlData>

  • GETFetch Forms API

  • GETFetch Single Record API<formLinkName>/getDataByID?recordId=261091000000049003

  • GETFetch Single Record API (Section Wise)<formLinkName>/getRecordByID?recordId=<recordId>

  • GETGet Related Records API<formLinkName>/getRelatedRecords?sIndex=<sIndex>&limit=<limit>& parentModule=<parentModule>&id=<id>&lookupfieldName=<lookupfieldName>

  • GETSearch Records Based on Record Values<formLinkName>/getRecords?searchParams={searchField: '<fieldLabelName>', searchOperator: '<operator>', searchText : '<textValue>'}

  • GETGet Fields of Form API<formLinkName>/components?

Cases API

  • POSTAdd Case API<Category ID>&subject=<subject>&description=<description>

  • GETView Case API<Reord ID of the case>

  • GETView Case Listing API<index>&status=<status>

  • GETView List of Categories API

Timesheet API

  • POSTCreate Timesheets API<user>&timesheetName=<timesheetName>&description=<description>&dateFormat=<dateFormat>&fromDate=<fromDate>&toDate=<toDate>&billableStatus=<billableStatus>&jobId=<jobId>&projectId=<projectId>&clientId=<clientId>&sendforApproval=<sendforApproval>

  • POSTModify Timesheets API<timesheetId>&timesheetName=<timesheetName>&description=<description>&sendforApproval=<sendforApproval>&removeAttachment=<removeAttachment>

  • GETGet Timesheets API<user>&approvalStatus=<approvalStatus>&employeeStatus=<employeeStatus>&dateFormat=<dateFormat>&fromDate=<fromDate>&toDate=<toDate>&sIndex=<sIndex>&limit=<limit>

  • GETGet Timesheets Details API<timesheetId>&dateFormat=<dateFormat>​

  • POSTApprove Timesheets API<authtoken>&timesheetId=<timesheetId>&approvalStatus=<approvalStatus>&timeLogs=<timeLogs>&comments=<comments>&isAllLevelApprove=<isAllLevelApprove>​

  • POSTDelete Timesheets API<timesheetId>​

Onboarding API

  • POSTTrigger Onboarding API<Employee|Candidate>/triggerOnboarding​

  • POSTAdd Candidate API<inputData>​

  • POSTUpdate Candidate API<inputType>/Candidate/updateRecord?inputData=<inputData>&recordId=<recordId>

Leave API

  • POSTAdd Leave API<inputType>/<formLinkName>/insertRecord?inputData=<inputData>

  • POSTGet Record API

  • PATCHCancel Leave API<record-id>

  • GETUser Report API

  • GETLeave Booked and Balance Report API

  • GETLeave Bradford API

  • GETEncashment Report API

  • GETLOP Report API


  • POSTAdd Leave Balance API<balanceData>&dateFormat=<dateFormat>

Attendance API

  • POSTBulk Import API<JSONArray>

  • GETFetch Last Attendance Entries API HH:mm:ss

  • POSTAttendance Check In Check Out API<dateFormat>&checkIn=<checkin time>&checkOut=<checkout time>&empId=<employeeId>&emailId=<emailId>&mapId=<mapId>

  • POSTAttendance Entries API<date>&dateFormat=<dateformat>&erecno=<erecno>&mapId=<mapId>&emailId=<emailId>&empId=<empId>

  • POSTAttendance User Report API<sdate>&edate=<edate>&empId=<employeeId>&emailId=<emailId>&mapId=<mapId>&dateFormat=<dateFormat>

  • POSTEmployee Shift Mapping API<dateformat>&empId=<employee Id>&shiftName=<shift name>&fdate=<FromDate>&tdate=<toDate>

  • GETGetting Shift Details Of Employee API<employee Id>&emailId<email Id>=&mapId<Mapper ID>=&sdate<startDate>=&edate=<endDate>

  • GETGet Regularization Records API

For more information and details on other endpoints, check out this detailed resource

Zoho People API Use Cases

  • Quick candidate onboarding with offer letter management, new hire portal, customizable workflows and status-view reports
  • Cloud-based attendance management system to generate insightful reports, regularize attendance, option to check in from anywhere 
  • Simple time off management tool with leave policy compliance, instant access to employee leave history, mobile leave applications and approvals and multi-location time off and holiday management
  • Productivity timesheets to view the details of the time spent on every project, task, and client, get a centralized overview of your tasks and time resources, calculate payouts faster with accurate employee time logs and automate invoicing
  • Shift scheduling to map employees to standard shifts, enable automatic shift rotation with a custom scheduler, mark, track, and analyze breaks and allowances
  • Performance management with 360-degree, continuous feedback system, to evaluate employees with customized performance appraisal methods
  • Case management to sort and organize employee questions, track their status, and reply promptly from a central location with an easily accessible knowledge base

Top customers

  • Zomato, an Indian multinational restaurant aggregator and food delivery company
  • The Logical Indian, an independent and public-spirited digital media platform for Indian millennials
  • IIFL Finance, a leading finance & investment services company
  • Meesho, an online shopping platform
  • Waterfield Advisors, a leading independent Multi-Family Office and Wealth Advisory Firm
  • DLT Labs, a global leader in the development and delivery of enterprise blockchain technologies and solutions

Zoho People API FAQs

  • What to do when you cannot use searchParams on Zoho People API (HTTP Status 400)? Answer
  • How to achieve webhook integration between Podio and Zoho People? Answer
  • How to get the attendance API from Zoho People in postman? Answer
  • What to do if permission is denied when trying to fetch records from Zoho People? Answer
  • How to parse through the following ZOHO People JSON string using VB.NET? Answer
  • How to write a custom function in Zoho People Deluge to fetch all the dates between from and to given? Answer
  • How to sync Zoho People with Google Calendar API for event time update without changing date? Answer

How to integrate with Zoho People API

To integrate your preferred applications with Zoho People API, you need valid Zoho People user credentials. In addition you also must have a valid authentication token or OAuth to access Zoho People API. 

Get started with Zoho People API

Integrating with Zoho People API requires engineering bandwidth, resources and knowledge. Invariably, building and maintaining this integration can be extremely expensive for SaaS companies. Fortunately, with Knit, a unified HRIS API, you can easily integrate with Zoho People API and other multiple HRIS applications at once. Knit enables users to normalize data from across HRIS applications, including Zoho People, 10x faster, ensure higher security with double encryption and facilitates bi-directional data sync with webhook architecture to ensure guaranteed scalability, irrespective of data load. Book a demo to learn how you can get started with Zoho People API with ease. 

API Directory
Feb 26, 2024

Ceridian Dayforce API Directory


Ceridian Dayforce API Directory

Ceridian Dayforce is an all-inclusive human capital management system that helps employers take care of all stages of an employee’s lifecycle, across HR, payroll, employee engagement, workforce management, services, etc. It is a cloud based system. Ceridian Dayforce enables businesses to unlock workforce intelligence, empower people, and manage compliance.

With the Ceridian Dayforce Connector, developers can get access to the REST API of Ceridian Dayforce HCM, to facilitate integrations across their preferred applications. With this REST API, organizations can store all information regarding their employees and retrieve it as and when the need arises. 

Ceridian Dayforce API Authentication

Ceridian Dayforce API supports authentication in 2 ways. First, developers can limit and authorize access via token based authentication. In this mechanism, Ceridian Dayforce verifies the user’s identity to provide a unique access token for API access. Second, developers can leverage the basic auth connection for Ceridian Dayforce API authentication. Here, a username along with a password and API key is what users can use to facilitate API access and ensure reliable authentication. In addition, Ceridian Dayforce API comes with AES 256 encryption, to ensure that the  connection’s password/ credentials are safe. 

Ceridian Dayforce API Objects, Data Models & Endpoints

When working with Ceridian Dayforce API, you need to understand the data models, objects and endpoints. Here is a quick overview to get started:


This object represents a dependent of an employee, including child, spouse, partner, etc. It contains data fields like first/last name, relationship, date of birth, gender, if the dependent is a student


This object covers all details relating to an individual or candidate who has been employed by the organization. It contains information or data fields like employee number, first/last name, preferred name, work email, personal email, groups, phone number, home/ work location, employments, manager, team, gender, marital status, employment status, start date, termination date, etc. 


This object represents a job position at any company. It contains data fields like employee, job title, pay rate, pay period, pay currency, effective date, employment type, pay frequency, etc. 


A group is a subset in which an employee can be placed. Groups can be of multiple types, including teams, pay groups. At the same time, each employee can be a part of multiple groups. It contains data fields or information along the lines of name, type, etc. 


This object represents the geographical area which can be associated with an employee. The location object contains data fields including name, street number, city, zip code, country, location type, state, etc. 


Team as an object is a subgroup of a company like a department. Each employee is allocated to a particular team as a part of their employment. 

Time Off

This object comprehensively represents time off entries for all employees to get a complete picture of attendance in the organization. It contains details like employee, status, employee note, units, amount, request type, start time, end time, etc. 

Time Off Balance

This object represents the current status or balance remaining as a part of an employee’s allocated time off. This includes data fields like employee, balance, policy type, among others. 

Common Ceridian Dayforce API endpoints

  • GET/v1/Employees/{employee_id}/DependentsBeneficiaries

With this endpoint, you can get access to information about the dependents, including their name, date of birth, relationship, etc. 

  • GET/v1/Employees

This endpoint can be used to get any information needed about the employee, including employment, time off, time off balance, etc. 

  • GET/v1/employees/{employee_id}/TimeAwayFromWork

This endpoint helps get access to information about time off including start time, end time, request type, etc. 

  • GET/v1/Employees/{employee_id}/WorkAssignments

With this end point, users can get access to information about an employee’s work assignment focusing on location, zip code, country, among others. 

  • GET/V1/Employees/{employee_id}/CompensationSummary

This endpoint helps get access to information about the employment and payroll in general, including pay period, pay frequency, rate, etc. 

Merge interacts with this API endpoint to...

  • GET/V1/Employees/{employee_id}

With this endpoint, one can get information about a particular employee, including personal email, home location, ethnicity, employment status, etc. 

  • GET/v1/OrgUnits

This endpoint is used to gain access to information about an employee’s team and groups the employee is a part of. 

  • GET/v1/EmployeeBalancePeriods

With this endpoint, users get access to information about the time off balance and policy type for each employee. 

Ceridian Dayforce API Use Cases

  • Provides a unified view for all employees, giving all information regarding performance, payroll, time off and other details on one platform, preventing any toggling for users
  • Facilitates in-depth and real time analytics for all HR data to help employers understand the health of their organization and make well-informed decisions in a timely manner. It provides a vast catalog of standard reports along with the option to customize reporting based on organizational needs 
  • Curates insights for business intelligence and helps organizations with flight risk assessment to prevent attrition, gauge personality types, easily access performance data and understand status for each employee
  • Ensures self service for employees to empower them to get quick access to their pay details, benefits and all the other information they might need. It also allows employees to update personal information and other details on their own, following chat commands for smooth onboarding and updates
  • Promotes role based access and security to uphold high levels of data privacy. This ensures that confidential data has very limited access and employees are only able to view data which is required and relevant to their role
  • Helps with workforce management to make data-driven staffing decisions, utilizing flexible scheduling for better business outcomes, streamline absence management and overall optimize HR operations for greater efficiency and productivity
  • Makes hire to retire employee lifecycle seamless with AI based screening and automated onboarding, personalized learning recommendations and succession planning, employee engagement interventions and much more

Top customers

With ~6000+ customers, Ceridian Dayforce is a popular HRIS/ HCM provider for organizations, especially in the United States. Here is a list of the top customers that Ceridian Dayforce is servicing:

  • CBS News, the news division of the American television and radio service CBS
  • Gannett Co., Inc., an American mass media holding company 
  • Amphenol Corporation, a United States based Manufacturing organization
  • Travis Perkins, a United Kingdom based Distribution organization 
  • The Hanover Insurance Group, Inc., a United States based Insurance organization
  • Harley-Davidson, Inc., a United States based Manufacturing organization
  • Marrakech Inc., a diverse nonprofit organization

Ceridian Dayforce API FAQs

  • How to facilitate Ceridian Dayforce Integration with Active Directory? Answer
  • What is the Ceridian Dayforce HRIS API location? Answer
  • How to extract the URL to call the Authenticate API method with Dayforce API? Answer
  • How to navigate Dayforce Reporting Custom Field SQL? Answer
  • How to set up a token-based auth connection to Ceridian Dayforce? Answer
  • How to set up a basic auth connection to Ceridian Dayforce? Answer
  • How to set up the Ceridian Dayforce Environment? Answer
  • What is a Ceridian Dayforce Connector Example? Answer
  • How to configure Ceridian Dayforce REST Operations? Answer
  • How to enable testing of the Ceridian Dayforce APIs against your own environment? Answer
  • How to contribute to the Ceridian Dayforce Connector? Answer

How to integrate with Ceridian Dayforce API

To start your integration journey with Ceridian Dayforce API, you need to create an account on the Ceridian Dayforce Developer Network and the same can be accessed here. In addition, you can also check out this Ceridian Dayforce Connector Overview for a detailed snapshot.  

Get started with Ceridian Dayforce API 

Ceridian Dayforce HCM doesn’t provide its pricing publicly on its website. However, interested customers can fill in their details or get in touch with the sales team with this link to get an understanding of how much it would cost to get access to Ceridian Dayforce API. To make the integration process smooth with Ceridian Dayforce API or any other HRIS API, you can get started with Knit, one API for all your integrations. Sign up with Knit, and you can integrate with top HRIS API in a short span of time at a fraction of the cost. 

Start building with Knit, today

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

Book Demo!