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

ATS API Integrations: All You Need to Know

This article discusses everything you need to know to build ATS API integrations: key data models, ATS concepts, use cases, top ATS APIs and get started guide

If you are looking to integrate multiple HRIS and ATS apps with a single API key, check out Knit API. If you are looking to learn more about key ATS API concepts, data models and use cases, keep reading.

One of the first steps towards fueling a high powered organization is by onboarding the right talent. However, with the changing skill sets and dynamics of recruitment, hiring is becoming increasingly complex. 

As a result, most companies today are relying on different applications to streamline and automate the entire hiring process.There are several applications that come together to build the Applicant Tracking System (ATS) and for application management, right from sending out a requisition to the final offer acceptance and onboarding. 

78% recruiters using ATS report having increased the efficiency of their hiring process. To make the process even more effective and efficient, companies want these applications to talk and automatically exchange data to keep pace with each other. Thus, ATS integration is becoming increasingly sought after, giving impetus to the rise of ATS API. 

In this article, we will cover the different facets of ATS integration, focusing on key concepts, use cases, data models, etc. to understand how ATS APIs will change the dynamics of recruitment. 

Key Applicant Tracking (ATS) concepts 

The first step to facilitate ATS integration is to understand the different ATS concepts that can help you familiarize yourself with the right terminology. 

1. Job requisition

Even before an organization starts receiving and processing applications, a key concept to understand is job requisition. Essentially, a job requisition is a template or a form which contains all the details about the job for which applicants are being sought. This includes details on the requirements as well as the process of closing the positions, like assessments, interviews, etc. It may also include details of the hiring manager and other relevant information. Different apps can have different ways of assigning job requisitions.  

2. Sourcing and mapping

Sourcing and mapping starts once the job requirements become clear. The HR or the recruitment manager generally navigates through different platforms and candidate pools to identify the right candidates and map them to different openings within the organization. Sourcing is when the hiring manager proactively reaches out to qualified candidates for a specific job opening. 

3. Candidates, attachments and applications

These three are integral concepts for any ATS API. While the terminology might change slightly for different applications, you will find all of these in some essence. 

  • Candidates refers to the individuals who apply for different roles and this category contains all details about them including name, location, skills, qualifications, etc. While most of the information is public, some information about disability, caste, religion, may be sensitive and stored privately.  
  • Next key ATS integration concept is that of attachments. Each candidate brings forth a set of documents that are relevant for the job they are applying to. These generally include the resume, cover letters, previous work samples, portfolios, etc. Together, these documents are referred to as attachments. 
  • Finally, a candidate may apply to one or more roles. Thus, they can have different applications. The application generally has information regarding when the application was started, current status, active or archive, etc. 

4. Interviews, activities and offers

Another set of concepts come into play when the communication with a candidate begins. 

  • The first of them is the ATS API concept of interviews. This object generally has information about the interview like the location, date and time, whether or not it happened, etc. 
  • Activities as a data object for ATS API refers to different communications that happen with a candidate. It includes details on emails, comments, and other aspects focusing on the subject, activity body, etc. 
  • Finally, after all communication and interviews, offers are rolled out to candidates. The offer object stores data such as the date the offer has been extended, till when it is valid, when the offer is to be accepted, job start date, etc. 

Top ATS APIs in the market

By now you understand that there are several layers to the ATS integration with different types of applications. Here are the top ATS APIs which you should consider connecting with to make hiring smooth and streamlined for your organization. 

top ATS APIs you must integrate with

1. Job posting APIs

The first set of ATS integration you should look out for is the one which can help you with job posting. This involves ensuring that your company profile and job openings are visible to potential candidates to generate interest and leads. 

Top job posting ATS API: Indeed, Monster, Naukri, The Muse

2. Candidate/ Lead sourcing APIs

Once the job has been posted, the next step is to build a pipeline of potential candidates. ATS applications for candidate and lead sourcing help extract important candidate data for profile matching, referrals, etc. 

Top candidate sourcing ATS API: Zoho, Freshteam, LinkedIn  

3. Resume parsing APIs

The next step after candidate sourcing is resuming sorting. Here resume parsing applications make sense for your ATS integration. These help with automated collection, storage and filtering of resumes. Resume parsing ATS APIs can help extract relevant information from resumes like skills, expected salary, previous experience, etc. to help align candidate profiles with job requirements. 

Top resume parsing ATS API: Zoho Recruit, HireAbility, CVViz

4. Interview management APIs

Resume screening needs to be followed by interviews to identify a role-fit for the candidates. However, interview management can be extremely complicated. ATS APIs for interviews help address all challenges, including assessments to gauge technical skills, scheduling, managing interview related travel information, etc. 

Top interview management ATS API: Calendly, HireVue, HackerRank,, Talview

5. Candidate communication APIs

Communicating effectively with the candidates is extremely important during the whole hiring process. ATS APIs for candidate communication can help automate email, text and other messages and keep track of all interactions in a streamlined manner. 

Top candidate communication ATS API: Grayscale, Paradox

6. Offer extension and acceptance APIs

Finally, once you decide to onboard a particular candidate, you need relevant ATS integration for extending the offer where the candidate can accept the same and share any document(s) that you might need for onboarding. Offer acceptance applications facilitate electronic signatures, and other formalities in a seamless manner. 

Top offer extension and acceptance ATS API: DocuSign, AdobeSign, DropBox Sign 

To check out Knit’s entire ATS and HRIS API catalog click here

7. Background verification APIs

When you are extending an offer, it is very important to ensure background verification or check for your potential employees. While you may have performed initial reference checks when you received the application, while hiring someone, you need to get a more comprehensive understanding of their profile. Doing this manually can be extremely time and resource extensive. 

Here, ATS integrations for background verification can help you run a check based on your required parameters on the candidate profile and flag any concerns if they appear. This way, you can be rest assured that the employees who come on board don’t have any form of ethical or legal or any other baggage. 

Top background verification ATS API: Certn, Hireology, HireRight, GoodHire

8. Analytics and reporting APIs

Now that your hiring is complete, you should analyze the entire process to gauge where you stand in terms of open positions, the DEI status for your organization, overall headcount, etc. ATS integration for analytics and reporting can help you get dashboard with all such information

Top analytics and reporting ATS API: LucidChart, ChartHop

ATS Integration Data Use cases 

One of the biggest benefits of ATS integration is that organizations are easily able to integrate a lot of data about the candidate and terms of hiring with significant new use cases. 

On one hand, organizations can internally use this data for better decision making and ensure effective human resources distribution. On the other hand, this data can become the foundation for other companies to facilitate seamless business continuity across industries. 

In this section, we will discuss the top ATS API use cases that SaaS companies are applying today.

I) Seamless onboarding

The first major use case for data from ATS APIs revolves around onboarding and building of HRIS data. With ATS integrations, important data about the candidate like demographic information, qualifications, documents, attachments, identity proofs etc. which are collected during the course of applicant tracking can be automatically transported to the HRMS or HRIS. Furthermore, the salary details and other terms of employment as shared during offer extension can also be communicated to the payroll APIs. 

This brings along twin benefits. 

  • First, the candidate doesn’t have to share the same information multiple times, making onboarding smooth for them. 
  • Second, your HR managers also don’t have to invest manual bandwidth and efforts in replicating the data for their records. 

II) Compensation management 

As mentioned, ATS API integrations can ensure that all details about the candidate compensation are shared with the payroll application to facilitate correct salary calculation and on-time disbursement. This is specifically useful if you are on a mass hiring mode and don’t want to delay your payroll. 

Furthermore, compensation data from your ATS, not only for the selected candidates but also the salary expectations and other details can help you ensure fair and equitable compensation management. This data can help you understand what the market expectations are and how you are able to address the same. Similarly, data from ATS API can help gauge discrepancies or differences that might crop up across gender, experiences, level of seniority. Invariably, this data can help you facilitate fair pay based on market standards to attract the best talent. 

At the same time, third party companies which are experts in compensation management and consulting can integrate this data with their findings to help you with the best practices.  

III) Diversity and inclusion

An essential part that you need to focus on during hiring and afterwards is the diversity and inclusion aspect of your workforce. The ATS API data can help you understand the diversity of the candidate pool vis-a-vis the final hiring and closing of positions. Based on this data, your internal DEI team or external experts can help you understand if there is a leakage of diversity along the way. 

Invariably this will encourage you to understand if some part of your hiring process is biased or if you are using ATS applications which are not inclusive enough. You can identify the positions or roles where your diversity ratio is specifically low to understand the concerns. Simultaneously, you can make conscious efforts to bridge this lack of diversity. 

IV) Automated job posting

ATS API data will be incredibly helpful in automating the job posting process. For instance, data from interviews and other applications can indicate the pipeline of candidates and their status. In case the pipeline for a particular role is getting extremely weak with a lot of rejections during interviews or offer acceptances, your ATS application for job boards can be triggered for job posting followed by candidate sourcing and resume parsing. 

Here, the idea is to reduce manual time that goes into identifying which roles are still open and doubling down efforts on sourcing candidates for the same. This will only be possible when you can get real time data with continuous sync from your ATS APIs about the status of different candidates and applications.  

Key ATS API data models 

Most ATS apps have specific data models which they use to streamline workflow and dataflow. As a unified API for ATS integration, Knit focuses on the following data models for ATS API:

Application info

Contains all applicant details like job ID, status, owner, credited to (who receives credit for the application), applied at, updated at, etc. It also contains information about the candidate, location, links and documents attached, among others. 

Application stage

The stage at which the applicant is currently at, ranging from applied to selected or rejected with a stage ID and stage name. 

Application interview

Keeps all the information regarding a candidate's interview, when it is scheduled for, start time, end time, status, list of interviewers, location, etc. 

Application rejection

Contains data and information about any rejected application or candidate, including job ID, reason for rejection, rejected at which stage, etc. 

Application offers

All the offers extended to an application. It contains the details about the offer as well as the status to define whether the offer has been extended, signed, declined. It also keeps data on when the offer was extended, when it was closed, etc.

Application resume

Application resume or attachments refers to all the documents (such as resume, cover letter etc) which are associated with a particular candidate or application. They are present in the form of downloadable links and when it was created. 

Along with these application data models, Knit also offers several key job data models. For more details, check our documentation 

Get started with unified ATS API

Now that you understand different aspects of ATS integrations, it’s time to get started with it. If you look closely, you will realize that there are several categories of applications within the ATS segment. Each application comes with its own API, data syntax, end points, data models, etc. Due to this immense fragmentation in the ATS market, a unified API for ATS integration is the need of the hour. 

A unified ATS API like Knit will help you normalize data from all your ATS applications and facilitate real time data sync to facilitate continuous and secure data exchange. 

However, when you plan to get started with a unified API for ATS integration, get yourself acquainted with the following questions.

What API format is being used?

The first thing you need to check is which API format does the unified API for ATS integration provide. By adding an additional abstraction layer, the unified API ensures that your engineering team has to only deal with only one API format. However, you need to check among the different API formats like REST, SOAP, RPC, GraphQL, etc. which one is the foundation for your unified API. 

Generally, REST based unified API is most sought after as it is lightweight, independent, scalable and flexible.  

How does it ensure authentication?

You need to ensure that your unified API for ATS integration supports unified authentication. Here, you don’t have to force custom logic to factor in different forms of authentication based on different applications. Rather, there is a single form of authentication that you can rely on, whereas integrating everything on the backend to prevent the back and forth is taken care of by the unified API provider. 

What is the set API rate limit?

Rate limit specifically refers to how many API calls can you make in a given period of time for information request or exchange. If you have a lower rate limit and more API calls, it can lead to distorted unified API behavior. 

This request or rate limiting needs to be made in conjecture with your customer needs to ensure smooth functioning. 

Are test accounts available?

You might add more ATS APIs to your unified API as your scope or need increases. However, chances are you might want to try them out before you actually implement them for your customers. Therefore, you should check whether or not your unified API offers test accounts. Their presence is imperative especially from an active development perspective and to ensure smooth functioning before you go live with new features or applications. 

Does it offer unified pagination?

Pagination essentially refers to how the data from different application APIs get sorted for exchange. A unified API for ATS integration should provide you with unified pagination, which supports all forms of pagination. A unified API can help abstract all forms of pagination including offset pagination, page pagination, cursor pagination, link pagination, etc. Post abstraction, it provides a unified pagination that provides a more consistent and better experience.  

What is the architecture followed?

In a unified API, you can use either webhook or polling first architecture for data sync. 

  • In a webhook architecture, the data gets synced automatically, with a push-based sync and no polling infrastructure is needed by the customer. Here, data updates are synced as and when they happen. 
  • However, for polling first architecture, data updates rely upon poll databases, requiring a separate infrastructure. You need to make an API call at frequent intervals to ensure data is synced periodically.

Thus, you need to decide which architecture you need. From an ease of use perspective, webhooks architecture makes sense for continuous sync without the need to maintain any additional infrastructure. 

Does it ensure ATS integration management?

Finally, you need to ensure that your unified API supports ATS integration management once the APIs have been implemented. Gauge whether or not it bears full responsibility for troubleshooting, handling errors and all other maintenance related activities. 

Knit unified API for ATS integration

As a unified API, Knit seeks to make it seamless for SaaS businesses to implement native integrations to scale their growth. With Knit API, you can shift the heavy lifting of integration building and maintenance as it takes care of:

  • Continuous data sync with a 100% webhook architecture (Knit is the only unified API in the market today that does not store any of your end-user data at our end, ensuring better security. Learn more)
  • Push based data-sync model, eliminating the need for any polling infrastructure
  • Customizable scopes for giving your end-users granular control 
  • DIY dashboard to make it easier for your CX to solve customer issues
  • Seamless integration maintenance and management, error handling, etc. 

Overall, with Knit as your unified API for ATS integration, you can save thousands of dollars and hundreds of hours in engineering resources, enabling you to provide a consistent developer experience and leverage ATS data from different applications to supercharge your ATS and hiring process. Get you Knit API keys today

Wrapping up: TL:DR

As we draw this article to a close, it is important to note that a unified API for ATS integration can help you seamlessly deal with the ATS market fragmentation and ensure smooth data exchange. Keep in mind factors like common authentication, pagination, test account, rate limits, etc. when making a choice. 

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!