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


Guide to APIs for ADP Workforce now


ADP is an industry leader offering a comprehensive human capital management suite (HCM solutions), bringing together payroll, attendance, HR, time, insights, and other services under one roof. Overall, ADP offers a suite of APIs that developers can get access to via the ADP marketplace. The ADP marketplace contains two types of applications that developers can leverage based on their use case, i.e., Data Connector and End User Application. ADP APIs are designed using an event-based pattern for resource management. ADP provides RESTful APIs.

ADP API follows OpenID Connect and Open Authorization (OAuth) 2.0 flows for comprehensive security. For each of them, ADP provides access tokens, which are used for secure calls to protect ADP Web APIs. Essentially, an access token is a time-bound token, or credential, which can be used to access protected ADP Web APIs restricted to an access scope. Access tokens are provided to the application during the integration process as part of the OpenID Connect and OAuth 2.0 authentication and authorization flow.

ADP API Authentication

To access and interact with ADP's APIs and authenticate users via single sign-on (SSO), you'll need a Certificate Signing Request (CSR). Accessing ADP's web services requires both a private key and a corresponding Web Services (WS) Certificate. This certificate shares client information with ADP, while the private key verifies the client's authenticity.The WS Certificate can either be generated through an automated process (ideal for those building a marketplace application) or through a manual process (ideal for those building their own business application). To know more about each of these processes, click here.  

ADP API Events and Endpoints

ADP API (ADP Workforce Now) uses the following endpoints to facilitate the flow of information and data across channels.


Worker: A person who works/ performs duties for an organization

Worker Images

  • GET/hr/v2/workers/{aoid}/worker-images/photo

Worker Profile Photo Management

  • GET/events/hr/v1/
  • POST/events/hr/v1/
  • POST/events/hr/v1/
  • GET/events/hr/v1/

Workers Data Retrieval

  • GET/hr/v2/workers/meta
  • GET/hr/v2/workers/{aoid}
  • GET/hr/v2/workers

Workers - Lifecycle Management

Worker.hire: Primary work assignment created between a worker/ person and the employer for the first time.

Rehire Worker

  • POST/events/hr/v1/worker.rehire
  • GET/events/hr/v1/worker.rehire/meta

Workers - Data Integration Management

Read Worker

  • GET/events/hr/v1/
  • POST/events/hr/v1/

Worker Demographics

Worker Demographics: Demographics and information for all workers as well as each worker specifically. 

Worker Demographics

  • GET/hr/v2/worker-demographics/meta
  • GET/hr/v2/worker-demographics
  • GET/hr/v2/worker-demographics/{aoid}

Worker Associate Profile - Personal & Work Info

Worker associate profile: Extensions to the worker profile containing hobbies/interests, bio, Standout roles, etc.

Associate Preferred Gender Pronoun

  • POST/events/hr/v1/worker.associate-profile.preferred-gender-pronoun.change
  • GET/events/hr/v1/worker.associate-profile.preferred-gender-pronoun.change/meta

Workers - Compensation Management

Add Additional Remuneration

  • POST/events/hr/v1/

Change Additional Remuneration

  • POST/events/hr/v1/

Change Base Remuneration

  • POST/events/hr/v1/

Remove Additional Remuneration

  • POST/events/hr/v1/

Workers - Work Assignment Management

Work assignment: Details such as a worker's Job Title and Job Function.

Modify Assigned Organizational Units

  • POST/events/hr/v1/

Modify Work Assignment

  • GET/events/hr/v1/
  • POST/events/hr/v1/

Modify Worker Reports 

  • POST/events/hr/v1/worker.reports-to.modify

Terminate Work Assignment

  • POST/events/hr/v1/

Personal Contacts

Personal connects: To retrieve, add, update, and delete an associate's emergency contacts.

Add Personal Contact

  • GET/events/hr/v1/worker.personal-contact.add/meta
  • POST/events/hr/v1/worker.personal-contact.add

Change Personal Contact

  • POST/events/hr/v1/worker.personal-contact.change
  • GET/events/hr/v1/worker.personal-contact.change/meta

Personal Contacts

  • GET/hr/v2/associates/{aoid}/personal-contacts/meta
  • GET/hr/v2/associates/{aoid}/personal-contacts
  • GET/hr/v2/associates/{aoid}/personal-contacts/{personal-contact-id}

Remove Personal Contact

  • GET/events/hr/v1/worker.personal-contact.remove/meta
  • POST/events/hr/v1/worker.personal-contact.remove

Worker Profile Experience (WFN)

Worker profile experience: Manage the HR Worker Profile implementation, add a new position for an employee and update the primary position of an employee, change the base remuneration details of an employee. 

Compensation Management

  • PUT/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/base-remuneration
  • GET/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/base-remuneration/meta
  • POST/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/additional-remunerations
  • GET/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/additional-remunerations
  • PUT/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/additional-remunerations
  • GET/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/reportable-benefits/meta
  • GET/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/additional-remunerations/meta
  • POST/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/reportable-benefits
  • GET/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/reportable-benefits
  • PUT/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/reportable-benefits

Corporate Groups Management

  • POST/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/corporate-groups
  • GET/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/corporate-groups/meta

Position Data Management

  • PUT/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/worker-dates
  • PUT/hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/primary-assignment

Workers - Business Communication Management

Add Worker Business Email

  • POST/events/hr/v1/

Add Worker Business Fax

  • POST/events/hr/v1/

Add Worker Business Landline

  • POST/events/hr/v1/

Add Worker Business Mobile

  • POST/events/hr/v1/

Add Worker Business Pager

  • POST/events/hr/v1/

Change Worker Business Email

  • POST/events/hr/v1/

Change Worker Business Fax

  • POST/events/hr/v1/

Change Worker Business Landline

  • POST/events/hr/v1/

Change Worker Business Mobile

  • POST/events/hr/v1/

Change Worker Business Pager

  • POST/events/hr/v1/

Remove Worker Business Email

  • POST/events/hr/v1/

Remove Worker Business Fax

  • POST/events/hr/v1/

Remove Worker Business Landline

  • POST/events/hr/v1/

Remove Worker Business Mobile

  • POST/events/hr/v1/

Remove Worker Business Pager

  • POST/events/hr/v1/

Corporate Directory

Corporate directory: List of corporate contacts or detailed information about a specific contact

Corporate Directory

  • GET/{sor-id}/hr/v1/corporate-contact-photos/{image-id}.{image-extension}

Work Assignment Management

Add Work Assignment

  • POST/hr/v3/workers/{aoid}/work-assignments
  • GET/hr/v3/workers/{aoid}/work-assignments/meta

Workers - Biological Data Management

Change Birth Date

  • POST/events/hr/v1/worker.birth-date.change

Change Gender

  • POST/events/hr/v1/worker.gender.change

Change Race

  • POST/events/hr/v1/worker.race.change

Change Worker Gender Identity

  • POST/events/hr/v1/worker.gender-identity.change
  • GET/events/hr/v1/worker.gender-identity.change/meta

Workers - Demographic Data Management

Change Birth Name

  • POST/events/hr/v1/worker.birth-name.change

Change Legal Name

  • POST/events/hr/v1/

Change Preferred Name

  • GET/events/hr/v1/worker.preferred-name.change/meta
  • POST/events/hr/v1/worker.preferred-name.change

Change Worker Marital Status

  • POST/events/hr/v1/worker.marital-status.change

Change Worker Military Classification

  • POST/events/hr/v1/worker.military-classification.change

Change Worker Military Status

  • POST/events/hr/v1/worker.military-status.change

Workers - Personal Communication Management

Add Worker Legal Address

  • POST/events/hr/v1/

Add Worker Personal Address

  • POST/events/hr/v1/worker.personal-address.add

Add Worker Personal Email

  • POST/events/hr/v1/

Add Worker Personal Fax

  • POST/events/hr/v1/worker.personal-communication.fax.add

Add Worker Personal Landline

  • POST/events/hr/v1/worker.personal-communication.landline.add

Add Worker Personal Mobile

  • POST/events/hr/v1/

Add Worker Personal Pager

  • POST/events/hr/v1/worker.personal-communication.pager.add

Change Worker Legal Address

  • POST/events/hr/v1/

Change Worker Personal Address

  • POST/events/hr/v1/worker.personal-address.change

Change Worker Personal Email

  • POST/events/hr/v1/

Change Worker Personal Fax

  • POST/events/hr/v1/worker.personal-communication.fax.change

Change Worker Personal Landline

  • POST/events/hr/v1/worker.personal-communication.landline.change

Change Worker Personal Mobile

  • POST/events/hr/v1/

Change Worker Personal Pager

  • POST/events/hr/v1/worker.personal-communication.pager.change

Remove Worker Legal Address

  • POST/events/hr/v1/

Remove Worker Personal Address

  • POST/events/hr/v1/worker.personal-address.remove

Remove Worker Personal Email

  • POST/events/hr/v1/

Remove Worker Personal Fax

  • POST/events/hr/v1/worker.personal-communication.fax.remove

Remove Worker Personal Landline

  • POST/events/hr/v1/worker.personal-communication.landline.remove

Remove Worker Personal Mobile

  • POST/events/hr/v1/

Remove Worker Personal Pager

  • POST/events/hr/v1/worker.personal-communication.pager.remove
  • GET/events/hr/v1/worker.personal-communication.pager.remove/meta

Workers - Work Deployment Management

Change Standard Hours

  • POST/events/hr/v1/

Change Worker Type

  • POST/events/hr/v1/

Workers - Custom Data Management

Change Worker Custom Percentage

  • GET/events/hr/v1/worker.custom-field.percentage.change/meta
  • POST/events/hr/v1/worker.custom-field.percentage.change

Change Worker Custom Telephone

  • POST/events/hr/v1/worker.custom-field.telephone.change
  • GET/events/hr/v1/worker.custom-field.telephone.change/meta

Manage Worker Custom Amount

  • GET/events/hr/v1/worker.custom-field.amount.change/meta
  • POST/events/hr/v1/worker.custom-field.amount.change

Manage Worker Custom Code

  • POST/events/hr/v1/worker.custom-field.code.change
  • GET/events/hr/v1/worker.custom-field.code.change/meta

Manage Worker Custom Date

  • GET/events/hr/v1/
  • POST/events/hr/v1/

Manage Worker Custom Indicator

  • POST/events/hr/v1/worker.custom-field.indicator.change
  • GET/events/hr/v1/worker.custom-field.indicator.change/meta

Manage Worker Custom Number

  • POST/events/hr/v1/worker.custom-field.number.change
  • GET/events/hr/v1/worker.custom-field.number.change/meta

Manage Worker Custom String

  • POST/events/hr/v1/worker.custom-field.string.change
  • GET/events/hr/v1/worker.custom-field.string.change/meta

Workers - Identification Management

Add Worker Government ID

  • POST/events/hr/v1/worker.government-id.add

Change Worker Government ID

  • POST/events/hr/v1/worker.government-id.change

Workers - Person Custom Data Management

Change Person Custom Amount

  • POST/events/hr/v1/worker.person.custom-field.amount.change
  • GET/events/hr/v1/worker.person.custom-field.amount.change/meta

Change Person Custom Code

  • POST/events/hr/v1/worker.person.custom-field.code.change
  • GET/events/hr/v1/worker.person.custom-field.code.change/meta

Change Person Custom Date

  • GET/events/hr/v1/
  • POST/events/hr/v1/

Change Person Custom Indicator

  • POST/events/hr/v1/worker.person.custom-field.indicator.change
  • GET/events/hr/v1/worker.person.custom-field.indicator.change/meta

Change Person Custom Number

  • POST/events/hr/v1/worker.person.custom-field.number.change
  • GET/events/hr/v1/worker.person.custom-field.number.change/meta

Change Person Custom Percentage

  • POST/events/hr/v1/worker.person.custom-field.percentage.change
  • GET/events/hr/v1/worker.person.custom-field.percentage.change/meta

Change Person Custom String

  • POST/events/hr/v1/worker.person.custom-field.string.change
  • GET/events/hr/v1/worker.person.custom-field.string.change/meta

Change Person Custom Telephone

  • GET/events/hr/v1/worker.person.custom-field.telephone.change/meta
  • POST/events/hr/v1/worker.person.custom-field.telephone.change

Worker Leaves

Worker leaves: Processing an employee's leave requests, changes, and return and leave cancellations.

Cancel Worker Leave

  • GET/events/hr/v1/worker.leave.cancel/meta
  • POST/events/hr/v1/worker.leave.cancel

Change Worker Leave

  • POST/events/hr/v1/worker.leave.change
  • GET/events/hr/v1/worker.leave.change/meta

Request Leave Of Absence

  • GET/events/hr/v1/worker.leave.absence.request/meta
  • POST/events/hr/v1/worker.leave.absence.request

Request Return From Leave Of Absence

  • POST/events/hr/v1/worker.leave.return.request
  • GET/events/hr/v1/worker.leave.return.request/meta

Worker Leaves

  • GET/hr/v2/workers/{aoid}/leaves

Workers - KSAOC Management

Change Worker Highest Education Level

  • POST/events/hr/v1/worker.highest-level-education.change
  • GET/events/hr/v1/worker.highest-level-education.change/meta

ADP API Use Cases

  • Easy to use, intuitive interface and highly customizable with efficient customer support
  • Access best-practice guides, HR forms, policies, and an employee handbook template
  • Automation of processes like onboarding, status change, offboarding
  • Providing employees access to to their pay, benefits and time information, offering true self service
  • Real time mobile phone access to important information like time off, benefits data, etc. with a mobile application
  • Tracking and monitoring of key metrics like labor costs, overtime, actual vs. scheduled hours, turnover rate for better HR services

Top Customers

  • Jelly Belly, gourmet jelly belly candies and confections manufacturer
  • Amazon, a vast Internet-based enterprise
  • The Boston Globe, an American daily newspaper
  • Dell Technologies, a provider of desktop personal computers, software, and peripherals
  • Sunstone Partners, a growth-oriented private equity firm


Here is a comprehensive list of questions that can help you navigate ADP API for success:

  1. How to obtain ADP API Client Secret for OAuth? Answer
  2. How to get ADP API past SSL error? Answer
  3. How to update ADP API Worker Information? Answer
  4. How to get Powershell ADP API Token? Answer
  5. How to Solve ADP API Connection Problem(Error : Status-58)? Answer
  6. How to change a person's custom string using ADP's API? Answer
  7. How to get access_token from ADP Api using rest? Answer
  8. What is the latest API updated or released for ADP Workforce Now? Answer
  9. What is the release plan for ADP Workforce Now APIs? Answer
  10. What are latest API updated or released for RUN Powered by ADP? Answer
  11. What APIs will be released or enhanced for RUN Powered by ADP soon? Answer
  12. How to integrate ADP employee data in Wordpress? Answer
  13. How to read properties from an ADP project by C#? Answer

Common Integrations with ADP API

While there can be multiple integrations and use cases for ADP API, here is a list of the top SaaS companies or products that can integrate with ADP API to facilitate customer success:

  • Learning Management Solutions
  • Rewards, Recognitions, and Performance
  • Communication and Collaborations
  • Employee Travel and Booking Tools
  • Workforce Planning and Org Chart Solutions

How to integrate with ADP API

Here is a comprehensive resource for anyone who wishes to integrate with ADP API and streamline and optimize their HR and allied operations. 

Get started with ADP API 

The pricing for ADP API is not publicly available. However, the platform does offer a demo for interested customers. At the same time, ADP provides tailor-made pricing based on specific company requirements. Thus companies can share the required information to get access to competitive pricing, across different tiers based on the features they need. You can request pricing here.

To make the integration process smooth with ADP, you can get started with Knit, one API for all your integrations. Sign up with Knit or book a demo here with one of our experts - Book Demo

Akshat Jain

SDE & DevRel

Coding chaos into innovation and building from zero to scale

Latest Blogs

Browse all Blogs
API Directory
Apr 9, 2024

A Guide toIntegrating with Freshteams API


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


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


(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


  • List all teams: GET /teams


  • List all levels: GET /levels


  • 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


  • 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


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


  • Companies: Used to get information about the company


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

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


GET{:id} (For information about a single employee)

GET (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{:employment_id} (For information on a specific employment

GET (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{:bank_id} (For information for a specific bank)

GET (For information for all banks across all people)

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


GET{:department_id} (For information regarding a single department:

GET (For information relating to all departments across all companies)

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


GET{:location_id} (For information relating to a single location)

GET (For information relating to all locations across all companies)

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


GET{:id} (For information relating to a single vacation request)

GET{: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{: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{: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


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



  • 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


  • 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


  • Get all departments

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


  • 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


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



  • 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


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



  • 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


  • 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


  • 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


Time Frames

  • Get time frame list.

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


  • 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


  • Get badge list.

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


  • Add Praise

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


Expense Category

  • Get all Expense Categories

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


  • 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



  • 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


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!