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

CRM API integration: All you need to know

Learn the key concepts associated with CRM APIs as well as how to get started with your CRM integrations

A CRM system or ‘Customer Relationship Management’ system is integral for business growth across all verticals. Irrespective of the function, almost everyone in an organization has data to capture, store and process to prevent missed opportunities and ensure seamless interactions and operations. Whether it is sales, marketing, human resources or operations, all teams use CRM systems in their own way. Research shows that 91% of companies with more than 11 employees use CRM software. Invariably, a software solution, regardless of the industry, needs to ensure compatibility and integration with the most popular CRM systems to ascertain easy flow of data and important information for each function. 

What are CRM APIs

From a macro view, a CRM system essentially helps businesses to capture, maintain and nurture all information about the different relationships for a company with existing and potential customers. These can be across sales, marketing, customer support, etc. A CRM API invariably helps companies to integrate CRM with other software that the companies use. Put simply, CRM API facilitates easy flow of data to and from the CRM and other software solutions to promote better decision making. A CRM API enables companies to connect their CRM with other applications and view all information on a single dashboard, without leaving their system of record. 

Types of CRM APIs

Based on the purpose they fulfill and the function they serve, CRM APIs can be divided into a few types. As businesses become more and more niche with specific requirements for each business vertical, CRM APIs have emerged which specifically cater to a particular function or role, leading to segments or categories within the CRM market. 

Sales CRM API

Primarily used to keep a track of and manage potential customers during the sales process. Focuses on capturing all conversations, requirements and other important information for relationship building and eventual conversion to a customer. 

Top sales CRM: Salesforce, SAP, Freshsales, Monday Sales, Zoho

Marketing CRM API

Focuses on seamless marketing management across campaigns, communication to ensure that all emails, other communication is sent appropriately. Helps organizations find new leads faster and nurture prospects better. Facilitates capturing and analyzing customer data and design marketing campaigns accordingly, powered by automation as well.

Top marketing CRM: Mailchimp, Hubspot, Adobe Marketo, Nutshell

Customer Support CRM API

Ensures customer success by tracking and resolving all customer requests and complaints on time. Helps address queries fast and seamlessly by presenting all information at one place along with historical conversations. Adds efficiency to customer success and aids alignment. 

Top customer support CRM: Zendesk, Salesforce Service Cloud, Zoho, Dynamics 365 for Customer Service

eCommerce CRM API

Facilitates tracking and nurturing of customers following the online sales and transaction process. Helps manage customer information, purchase behavior and other analytics data. Collects all data about customer interaction on your website/ eCommerce platform. 

Top eCommerce CRM: Pipedrive, Shopify, Salesforce Commerce Cloud, Capsule 

HR CRM API

Enables HR teams and recruiters to keep track of all data and information related to hiring. Helps capture conversations and relationships with candidates, identify and track open positions. 

Top HR CRM: DarwinBox, Workday HCM, Zoho

CRM API key concepts

To leverage CRM API to integrate data across software applications that you use or are providing, it is important to understand some of the key concepts or terminologies that are used. Each of these concepts has specific data schemas associated with them which we will discuss in the subsequent section. 

Contacts vs Leads

While many concepts will be different and unique across different CRM that you might come across, there are a few which are generally consistent. Contacts is one such concept. Essentially, Contacts refers to the unique users that you add to a CRM around which you wish to maintain the data or information. Each Contact may be associated with an Account or a company they most closely relate to.  

While Contacts is the most common concept, many CRM also have the concept of a Lead, which aren’t necessarily associated with any Account. They are generally raw data of people you add, which once qualified are converted to Contacts. 

Custom Objects and Fields

One of the key characteristics of CRM is its potential for customization. Depending on the nature of your business and function, you can add or create custom objects and fields on standard objects to collect the information in a way that makes sense for your business. 

CRM APIs data schemas

Within each of the concepts mentioned above, there are CRM API data schemas that ultimately guide the information flow and facilitate integration. While there will be a lot of data beyond this as well, here are some CRM API data schemas that can help you get started with CRM integration. 

As mentioned, the core of any CRM will be Contacts, which are primarily all users or entries you have in your CRM against which you will capture key information or data. Generally, a Contact has data in the form of name, email address, postal address, phone number, unique user ID, etc. In addition, there can be custom fields which can be used to capture additional information relevant to the business. A Contact might be linked to an Account or might be an Opportunity if it is a part of an ongoing sales conversation. 

A related concept for CRM API mentioned above is Leads. Leads are generally captured early on in the CRM sales process. They are eventually converted to Contacts when they are qualified with more information. A Lead is generally a sole entity and is not associated with any Account or Opportunity. The data schemas for Leads are similar to Contacts, including name, email address, postal address, phone number, unique user ID, etc. 

Next, we have Accounts. Accounts are primarily the companies or organizations that are a part of your CRM. Contacts are often associated with the Accounts. Normally, each Account can have multiple Contacts associated with it, considering the CRM owner might be interacting with or wants to store data of more than one person in a particular Account. The data schemas for Accounts are more macro in nature and include company name, industry, location, website, business address, number of employees, founded in, etc. 

Finally, there are Opportunities, especially in a sales CRM, which help the sales representatives to keep track of the sales funnel and facilitate a smooth conversion process. Any types of subscriptions or purchase processes are captured as Opportunities. Each Opportunity is associated with either an Account or a Contact to get access to the information about the respective stakeholder. The data schema for Opportunities focuses on the size of the deal, name of the sales representative or the person leading the deal, status of the deal, expected revenue, reference, close date, etc. 

In addition to these data schemas for different concepts, there is a data schema of notes which can be associated with all of these concepts of Accounts, Contacts, Leads, Opportunities. Essentially, notes contain updates and latest information on the status of each of the concepts and are important for capturing developments in the relationship. 

CRM API use cases

CRM API or CRM integration can help leverage the data and information captured to facilitate better business outcomes. In fact, many leading companies can use CRM API data to power their operations across:

Prospect nurturing

As the CRM API captures all critical information, it has access to details about important dates and events for each potential customer. CRM API integration with gifting and other lead nurturing platforms can help trigger incentives and other reinforcements for customers based on the information stored. For instance, CRM integration with a gifting platform can be trained to automatically send flowers or gift cards to each prospect in a particular segment for their birthday or any other event. Similarly, it can be used to acknowledge existing customers and clients by celebrating their anniversaries with the company, etc. 

Example: Xoxoday, Sendoso, Alyce, Reachdesk

Lead management

Most sales people have conversations with prospective customers across different platforms, including email, chat, social networking sites, etc. A CRM API can ensure that all conversations from these platforms are captured at one place, aligned with existing contacts or accounts or by creating new accounts and contacts as necessary. 

Example: LinkedIN, Outlook

Schedule management

CRM API integration with schedule management and calendar software or applications can help organizations seamlessly manage meetings and calendars for prospect meetings and customer interactions. CRM integration with such platforms can help people directly convert their opportunities into meetings. Furthermore, CRM API can record meetings, which can later be routed to different sales owners/ stakeholders for next action. 

Example: Calendly, Chili piper, Youcanbook.me, Doodle

Customer servicing

Your customer support teams are bound to get queries and complaints from your customers in the form of tickets and other mechanisms. If you integrate your CRM, these tickets and information can be captured against each Contact and even new Contacts can be added to specific Accounts. With CRM API all customer communication based on help desk and ticketing can be managed and streamlined for a better experience. 

Example: Freshdesk, Jira 

Communication

Since CRM is the sole aggregator of all communication, its integration with different communication channels is integral. This CRM API integration can help companies capture and store all communication and conversations in one place, which can then be used to populate and steer different conversations. At the same time, it can help keep a track of the conversation history across platforms for easier follow ups. 

Example: WhatsApp, Slack, Teams

eCommerce experiences

CRM integrations or CRM API can highly streamline eCommerce transactions and experience. Integration between CRM and eCommerce platforms can help you track purchases, orders, communication to the customers and capture all customer preferences. Their preferences can then be leveraged to create personalized campaigns, custom communication and other functionalities for a better user experience. 

Example: Shopify, BigCommerce

Legal and financial paperwork

Generally, conversations with potential customers can lead to successful sales, post which the paperwork and other formalities come into place. CRM API integration with financial and other onboarding tools can ensure that as soon as the status for any Opportunity is changed, the relevant documentation and paperwork process commences. Similarly, CRM can integrate with contract management and creation systems to facilitate the entire compliance part of a sales deal. For instance, any deal closure status change can trigger the sending of a standard contract to the customer via platforms like DocuSign to take care of the formalities and compliances. 

Example: DocuSign, signNow, HelloSign

Customer engagement

CRM API integration can help you automate a major part of your customer engagement and churn management process. You can regularly gauge the pulse of your customers by connecting your CRM with survey management and other platforms which can be triggered to send surveys to your contacts at regular intervals. Furthermore, with insights from customer health based on tickets/ complaints and queries, such integration can also help you generate propensity scores for each customer for repeat sales and upselling. 

Example: SurveyMonkey, Vitally

Marketing management

Finally, CRM API can help streamline and add efficiency to the marketing process. It can help capture new leads generated through different campaigns and even record preferences and other data to understand customer preferences. Based on this, it can understand the effectiveness of the campaigns and even assist in personalized communication for better conversion. 

Example: MailChimp, TypeForm, Facebook

CRM API integration: Top challenges

While there are several benefits of using CRM API integration based on the use cases mentioned above, creating CRM integration for your software solution can be daunting for a variety of reasons: 

First, there are a lot of CRM platforms that are under use currently by different companies. If you wish to provide CRM integration, you need to include at least the most popular ones in the market, which in itself can run into triple digits. Building integrations in-house for so many CRM systems will require a lot of engineering resources, time and investments. 

Second, CRM are very data intensive and record all information for any organization. Invariably, as the requirement varies across organizations, the nature and fields are customizable. Therefore, CRM integration requires a high level of data normalization across different fields which is a highly time consuming task. Even if the category is the same, the data model or schema can be different which makes integration all the more time consuming as data needs to be normalized for the same business logic to work across CRM systems being used. Data inconsistencies can lead to a poor experience.

Third, security and privacy is a common challenge or risk associated with CRM integration. Since the CRM is the source of very sensitive information, maintaining APIs in-house can lead to apprehensions about security and compliance. 

Get started with Unified CRM API

It is true that there are certain challenges or risks associated with CRM API integration. However, the benefits definitely outweigh the challenges. At the same time, you can simply get started with a unified CRM API to take care of all the challenges and risks, while you access the benefits. However, to make the right choice of which unified CRM API to choose, consider the following:

Auth component

The first consideration is that of the auth component which determines the design and styling of how well the unified CRM API will integrate with your application or software in terms of the look and feel. Consider choosing a unified API which offers higher flexibility in design and is more customizable. This will ensure greater similarity in experience for your customer between the integration and your application. 

For instance, Knit unified API used Javascript SDK as the auth component, facilitating greater scope for flexibility and customization in terms of design alignment with the core software. 

Integration management

Since maintenance and management is a critical part of why you might go for a unified CRM API, you should consider the integration maintenance being provided. Your unified API must be able to identify when records were synced, rerun syncs, etc. that can help identify and address integration issues in itself. With such comprehensive support, your teams might have to constantly reach out to the engineering teams of the unified CRM API provider which can often be time consuming. 

Here, Knit provides deep RCA and resolution, which essentially means that you don’t have to worry about integration maintenance and the platform will take care of everything. Your teams don’t have to go through logs to understand the problem and can focus on product enhancements and features. 

Architecture

A unified CRM API can have either a polling first or a webhooks architecture, depending on how data sync takes place. A polling first architecture relies on poll databases and requires API calls to facilitate data sync along with separate infrastructure. Whereas, a webhook infrastructure facilitates automatic data sync in real time. A webhook architecture comes with less maintenance issues. 

Knit offers a webhook events driven architecture which guarantees data delivery and scalability irrespective of the amount of data being synced between the source and destination apps, which a polling first architecture used by many other unified APIs may not support. 

Data storage

A common feature among unified CRM API is the storage of your data in the provider's network. This can lead to serious security challenges, especially because any CRM that you might integrate is likely to be a repository of a lot of data for your customers. Therefore, the unified CRM API you choose should not store a copy of your data for better security. No data storage comes along with several benefits for you from a compliance standpoint and will even make it easier for you to convince your customers while making a sale. 

Since Knit has built a completely events driven architecture from the ground up, the platform doesn’t store a copy of any data that flows through the unified API. It works only with webhooks and delivers both the initial and delta syncs to your app via events. Invariably, this facilitates a high level of confidence about data security, leading to accelerated deal closures. 

Other factors like end points, authentication, pagination, rate limits, test accounts must also be considered when making a decision on which unified CRM API to choose. Be cognizant of the API format that your unified API provider offers. While there are multiple options like REST, SOAP, GraphQL, REST format is considered to be the most user friendly. This will ensure that your developers and engineering team doesn’t have to always stay on top of it and it can be managed by others as well. 

In terms of rate limits, make sure you have a clear idea of how many API calls you will be needing in a given period of time. You might face troubleshooting issues if you need more API calls that the rate limits, leading to poor experience. Similarly, test accounts to try and test API implementation prior to going level can help you build confidence about the new functionalities you are offering to your customers. 

Wrapping up: TL:DR

To conclude, it is clear that CRM systems are being used by almost all organizations that you might pitch your software or application to. If you want a ready yes, providing CRM integration is the quickest way. However, with a plethora of CRM systems in the market today as well as the need for customization, integrating each CRM system individually can be a nightmare for your engineering team. Thus, go for a unified CRM API which provides you with a single API for integration with your software. Make sure you look at the auth component, maintenance, data security, and other parameters mentioned above to make an informed choice and facilitate seamless CRM integration with your software.

Sudeshna Roy

Head of Content, Knit

Decoding product and generating users with valuable content

Latest Blogs

Browse all Blogs
API Directory
Apr 9, 2024

A Guide toIntegrating with Freshteams API

11
mins

Freshteam API Directory

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

Freshteam API Authentication, Filtering, Rate Limits

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

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

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

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

Freshteam API Objects, Data Models & Endpoints

Employees

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

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

Branches

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

  • List all branches: GET /branches

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

Departments & Sub-Departments

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

Business Units

  • List all business units: GET /business_units

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

Teams

  • List all teams: GET /teams

Levels

  • List all levels: GET /levels

Timeoffs

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

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

Roles

  • List all roles: GET /roles

Job Postings

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

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

Candidate Sources

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

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

User Functions

  • List all user functions: GET /user_functions

New Hires

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

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

Freshteam API Use Cases

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

Top customers

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

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

Freshteam API FAQs

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

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

Common Integrations with Freshteam API 

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

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

How to integrate with Freshteam API 

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

Get started with Freshteam API 

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

API Directory
Apr 9, 2024

A Guide to Integrating with Zenefits APIs

11
mins

Zenefits API Directory

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

Zenefits API Authentication, Filtering, Rate Limits

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

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

Zenefits API Objects, Data Models & Endpoints

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

  • Applications: Used to return information about the application

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

  • Companies: Used to get information about the company

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Fields include: 

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

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

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

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

Fields include:

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

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

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

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

Fields include: 

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

Zenefits API Use Cases

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

Zenefits API FAQs

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

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

Common Integrations with Zenefits API 

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

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

How to integrate with Zenefits API 

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

Get started with Zenefits API 

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

API Directory
Mar 21, 2024

Comprehensive Guide to Keka API Directory

11
mins

Keka is a leading human resources management system that enables organizations to seamlessly manage diverse aspects of their human resource processes, including recruitment and onboarding, attendance and time management, payroll, expense and performance management. With OAuth authentication, rate limiting, pagination, and adherence to industry standards, Keka provides developers with everything they need to build robust integrations with their software/ platform and facilitate data exchange between their application and this leading HRMS portal. 

Keka API Authentication, Pagination, Rate Limit

To ensure safe and secure access, Keka API uses OAuth for authentication. This suggests that for successful integration, developers need an access token which can be generated with specific details. This includes client id (identifier for the client), client secret (for secure authentication), api key (unique API key for accessing the system), scope (requires passing kekaapi for this key). To facilitate integration testing for applications, developers can also leverage the Sandbox Environment which is offered by Keka. This allows developers to ensure robust functionality, before integration production begins. Keka APIs already come with pagination implemented to ensure response time optimization. The standard or the default page size in Keka is 100 with 1 being the default page number. 

API limit is a critical element of any API and so is the case with Keka, which helps define the number of requests that can be made to Keka within a limited time period. Keka has a rate limit of 50 API requests/ minute. This suggests that once 50 requests are made in a minute, the user needs to wait for the quote to be refilled before any other request is made. The rate limits are enforced and automatically reset after 60 seconds. In case a request is made before the quota is refilled, a 429 error with the reason rateLimitExceeded will be sent. 

Keka API Objects, Data Models & Endpoints

As a developer or the representative of an organization seeking to integrate with Keka API, it is important to understand the endpoints that you will be using eventually for data exchange, both when it comes to read APIs (getting data from Keka) as well as write APIs (providing data to Keka). 

CORE HR

Employees

  • Get all Employees

GET https://{company}.{environment}.com/api/v1/hris/employees

  • Create an Employee

POST https://{company}.{environment}.com/api/v1/hris/employees

  • Get an Employee

GET https://{company}.{environment}.com/api/v1/hris/employees/{id}

  • Get all update fields

GET https://{company}.{environment}.com/api/v1/hris/employees/updatefields

  • Update Employee personal details

PUT https://{company}.{environment}.com/api/v1/hris/employees/{id}/personaldetails

  • Update employee job details

PUT https://{company}.{environment}.com/api/v1/hris/employees/{id}/jobdetails

Groups

  • Get all Groups

GET https://{company}.{environment}.com/api/v1/hris/groups

  • Get all Group Types

GET https://{company}.{environment}.com/api/v1/hris/grouptypes

Departments

  • Get all departments

GET https://{company}.{environment}.com/api/v1/hris/departments

Locations

  • Get all Locations

GET https://{company}.{environment}.com/api/v1/hris/locations

Job Title

  • Get all job titles

GET https://{company}.{environment}.com/api/v1/hris/jobtitles

Currency

  • Get all currencies

GET https://{company}.{environment}.com/api/v1/hris/currencies

Notice Period

  • Get all notice periods

GET https://{company}.{environment}.com/api/v1/hris/noticeperiods

LEAVE

Leave Types

  • Get all Leave Types

GET https://{company}.{environment}.com/api/v1/time/leavetypes

Leave Balance

  • Get all Leave balances

GET https://{company}.{environment}.com/api/v1/time/leavebalance

Leave Requests

  • Get all Leave Requests

GET https://{company}.{environment}.com/api/v1/time/leaverequests

  • Create an Leave Request

POST https://{company}.{environment}.com/api/v1/time/leaverequests

ATTENDANCE

Attendance

  • Get all Attendance Records

GET https://{company}.{environment}.com/api/v1/time/attendance

Attendance Capture Scheme

  • Get all captureschemes

GET https://{company}.{environment}.com/api/v1/time/capturescheme

Holiday Calendar

  • Get all holidays Calendar

GET https://{company}.{environment}.com/api/v1/time/holidayscalendar

PAYROLL

Salary Components

  • Get all Salary Components

GET https://{company}.{environment}.com/api/v1/payroll/salarycomponents

Pay Groups

  • Get all Pay Groups

GET https://{company}.{environment}.com/api/v1/payroll/paygroups

Pay Cycles

  • Get all Pay Cycles

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles

  • Get Pay Register

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/payregister

  • Get all Pay Batches

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches

  • Get all Batch Payments

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches/{payBatchId}/payments

  • Update the Payments status

PUT https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches/{payBatchId}/payments

Pay Grades

  • Get all Pay Grades

GET https://{company}.{environment}.com/api/v1/payroll/paygrades

Pay Bands

  • Get all Pay Bands

GET https://{company}.{environment}.com/api/v1/payroll/paybands

PSA

Clients

  • Get all clients

GET https://{company}.{environment}.com/api/v1/psa/clients

  • Create a Client

POST https://{company}.{environment}.com/api/v1/psa/clients

  • Get a client

GET https://{company}.{environment}.com/api/v1/psa/clients/{id}

  • Update a Client

PUT https://{company}.{environment}.com/api/v1/psa/clients/{id}

Project Phases

  • Get project phases.

GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/phases

  • Create a Project Phase

POST https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/phases

Projects

  • Get all projects.

GET https://{company}.{environment}.com/api/v1/psa/projects

  • Create a Project

POST https://{company}.{environment}.com/api/v1/psa/projects

  • Get a project

GET https://{company}.{environment}.com/api/v1/psa/projects/{id}

  • Update a Project

PUT https://{company}.{environment}.com/api/v1/psa/projects/{id}

  • Get a project allocations

GET https://{company}.{environment}.com/api/v1/psa/projects/{id}/allocations

  • Get project timesheet entries.

GET https://{company}.{environment}.com/api/v1/psa/projects/{id}/timeentries

Tasks

  • Get project tasks.

GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks

  • Create a task

POST https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks

  • Update a task

PUT https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks/{taskId}

  • Get project task time entries.

GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks/{taskId}/timeentries

PMS

Time Frames

  • Get time frame list.

GET https://{company}.{environment}.com/api/v1/pms/timeframes

Goal

  • Get goal list.

GET https://{company}.{environment}.com/api/v1/pms/goals

  • Update goal progress

PUT https://{company}.{environment}.com/api/v1/pms/goals/{goalId}/progress

Badge

  • Get badge list.

GET https://{company}.{environment}.com/api/v1/pms/badges

Praise

  • Add Praise

POST https://{company}.{environment}.com/api/v1/pms/praise

EXPENSE

Expense Category

  • Get all Expense Categories

GET https://{company}.{environment}.com/api/v1/expense/categories

Expense

  • Get all Expense Claims

GET https://{company}.{environment}.com/api/v1/expense/claims

Expense Policy

  • Get all expense policies

GET https://{company}.{environment}.com/api/v1/expensepolicies

ASSETS

Asset

  • Get all Assets

GET https://{company}.{environment}.com/api/v1/assets

Asset Type

  • Get all Asset Types

GET https://{company}.{environment}.com/api/v1/assets/types

Asset Category

  • Get all Asset Categories

GET https://{company}.{environment}.com/api/v1/assets/categories

Asset Condition

  • Get all Asset Conditions

GET https://{company}.{environment}.com/api/v1/assets/conditions

Keka API Use Cases

  • Easy payroll processing and integration with attendance and leave to ensure proper calculation of payroll and taxes
  • Covers every HR workflow to manage people processes, including hiring, onboarding, probation confirmation, internal movements, etc.
  • Streamline all HR operations with automated workflows, comprehensive analytics, and hassle-free employee management
  • Conduct a multi-dimensional assessment of employees' abilities, behavioral competencies, and performance for constructive team evaluation
  • Get an accurate view of revenue against each project, resources allocation, and amount of time spent
  • Robust attendance management system that integrates every aspect of time tracking, including scheduling shifts, and tracking over-time, fully integrated with payroll

Top Customers

Keka, as an HRMS tool, is widely used with 5000+ customers, including:

  • Noise, India's trusted wearable watch brand
  • GrabOn, one of India’s top players in the coupons and deals industry
  • ICM, a UK-based global multi-regulated financial service provider
  • Easypolicy, a leading insurance aggregator
  • Traveazy, a Dubai-based travel-tech company focused on simplifying pilgrimage travel
  • Unbox Robotics, a leading supply chain robotics technology company specializing 
  • HackerEarth, a comprehensive developer assessment software that helps companies accurately measure developers' skills while recruiting
  • Metrochem API, a manufacturer of Active Pharmaceutical Ingredients (APIs), Pellets, and Intermediates in Multi Therapeutic segments

Keka API FAQs

Here’s a list of quick FAQs which will help answer any thoughts that you might have during your journey of integrating your application with Keka API

  • How can an admin create an API access key on Keka? Answer
  • How to integrate the Mettl assessment app with Keka Hire? Answer
  • How to integrate Naukri with Keka Hire? Answer
  • How to integrate Keka Hire with HackerEarth for Sending Assessments? Answer
  • How to integrate Keka Hire with LinkedIn? Answer 
  • How to integrate MS Teams account with Keka Hire? Answer
  • How to integrate SpringVerify with Keka? Answer

How to integrate with Keka API 

If you are just getting started, it might be a good idea to go through this documentation to understand how you can initiate the integration process. The detailed documentation contains everything you need to know about the overview, endpoints and much more. Leverage this to learn about the different data models scope and other details which will come in handy to get started. At the same time, this link will help you generate the access token for seamless authentication. 

Get started with Keka API 

While the guide shared above will serve as a comprehensive starting point for you to integrate your application with Keka API, it is important to understand that the entire process can be engineering heavy, time consuming and resource intensive. Put simply, it’s not just about building an integration, but also about managing and maintaining it over time. At the same time, if you want to connect with other HRMS APIs, the process becomes multifold. In such a situation, leveraging a unified HRMS API like Knit can come in handy. Knit enables SaaS businesses to easily connect with multiple HRMS applications by integrating once with its unified API, eliminating the need to connect with each application separately.

Book a demo call today to learn how you can accelerate your integration journey with Keka and other HRMS applications using Knit. 

Start building with Knit, today

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

Book Demo!