API Directory
-
Jul 9, 2024

Workday API Directory

Founded in 2005, Workday is a leading provider of financial, HR and planning software. It facilitates financial management, human capital management and analytics management for companies, students/ educational institutions and government agencies. They provide solutions across analytics and reporting, payroll, workforce management, spend management, talent management, professional services automation. 

For a detailed guied on Workday API integrations, read our in-depth guide to the Workday API. Below you will find a comprehensive directory of Workday API endpoints.

Workday API endpoints

While there are several Workday API endpoints, some of the top ones include:

Absence management

  • GET /balances/{ID}
  • GET /workers/{ID}/eligibleAbsenceTypes
  • GET /workers/{ID}/leavesOfAbsence/{subresourceID}
  • POST /workers/{ID}/requestTimeOff
  • GET /workers/{ID}/validTimeOffDates
  • GET /values/leave/status/
  • GET /values/timeOff/status/

Compensation

  • GET /scorecardResults
  • GET /scorecards/{ID}
  • POST /workers/{ID}/requestOneTimePayment

Payroll

  • GET /jobs/{ID}/payGroup
  • GET /payGroupDetails/{ID}
  • POST /taxRates
  • GET /values/payrollInputsGroup/payComponents/

Performance management

  • GET /feedbackBadges/{ID}

Recruitment

  • GET /interviews
  • GET /interviews/{ID}/feedback
  • GET /jobPostings/{ID}
  • GET /prospects/{ID}/educations
  • POST /prospects/{ID}/experiences
  • GET /prospects/{ID}/resumeAttachments
  • GET /prospects/{ID}/skills
  • GET /values/common/countries/

Time tracking

  • POST /timeClockEvents
  • GET /timeValidations
  • GET /workerTimeBlocks/{ID}
  • POST /workers/{ID}/timeReviewEvents

Talent management

  • POST /createMentorshipForMe
  • POST /createMentorshipForWorker
  • POST /mentorships/{ID}/close
  • POST /mentorships/{ID}/edit

Here’s a detailed guide on all Workday API endpoints as a ready reference.

Workday API use cases

  • Financial management with accounting and finance, revenue management, grants management, analytics and reporting, audit and internal controls
  • Human capital management via payroll and workforce management, talent, help, knowledge, and case management, workforce planning
  • Adaptive ERP to automate and streamline plans, budgets, and forecasts and align headcount, sales, and operational plans
  • Employee voice to collect and analyze feedback, with insights on employee experience to drives organizational success with AI
  • Spend management with sourcing project intake, pipeline management, contract management, supplier onboarding and performance management

Workday API FAQs

Check out the top FAQs for Workday API to help you get started

  1. Is a Workday WID a UUID? Answer
  2. How to authenticate Workday SOAP API? Answer
  3. How to receive real time notifications for my Workday? Answer
  4. How to get a Workday worker / employee web profile URL? Answer
  5. How to authenticate Spring SOAP to Workday? Answer
  6. How to edit worker additional data using Workday API? Answer
  7. How to create XSLT process Workday report - XML to JSON output - method="json" <xsl:output method="json" />? Answer
  8. How to create a calculated Field in Workday with multiple conditions? Answer

Get started with Workday API

Workday doesn’t offer its pricing publicly and you can get in touch with their team for the same. However, if you are looking to integrate with multiple HRMS or Recruitment APIs in the shortest time, you can get started with Knit, one API for all top HR integrations.

To sign up for free, click here. To check the pricing, see our pricing page

API Directory
-
Jul 9, 2024

ADP API Endpoints and Directory

ADP API

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.

Related: ADP API Integration (In-Depth) Guide

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.

Workers

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/worker.photo.remove/meta
  • POST/events/hr/v1/worker.photo.remove
  • POST/events/hr/v1/worker.photo.upload
  • GET/events/hr/v1/worker.photo.upload/meta

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/worker.read/meta
  • POST/events/hr/v1/worker.read

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/worker.work-assignment.additional-remuneration.add

Change Additional Remuneration

  • POST/events/hr/v1/worker.work-assignment.additional-remuneration.change

Change Base Remuneration

  • POST/events/hr/v1/worker.work-assignment.base-remuneration.change

Remove Additional Remuneration

  • POST/events/hr/v1/worker.work-assignment.additional-remuneration.remove

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/worker.work-assignment.assigned-organizational-units.modify

Modify Work Assignment

  • GET/events/hr/v1/worker.work-assignment.modify/meta
  • POST/events/hr/v1/worker.work-assignment.modify

Modify Worker Reports 

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

Terminate Work Assignment

  • POST/events/hr/v1/worker.work-assignment.terminate

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/worker.business-communication.email.add

Add Worker Business Fax

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

Add Worker Business Landline

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

Add Worker Business Mobile

  • POST/events/hr/v1/worker.business-communication.mobile.add

Add Worker Business Pager

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

Change Worker Business Email

  • POST/events/hr/v1/worker.business-communication.email.change

Change Worker Business Fax

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

Change Worker Business Landline

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

Change Worker Business Mobile

  • POST/events/hr/v1/worker.business-communication.mobile.change

Change Worker Business Pager

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

Remove Worker Business Email

  • POST/events/hr/v1/worker.business-communication.email.remove

Remove Worker Business Fax

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

Remove Worker Business Landline

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

Remove Worker Business Mobile

  • POST/events/hr/v1/worker.business-communication.mobile.remove

Remove Worker Business Pager

  • POST/events/hr/v1/worker.business-communication.pager.remove

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/worker.legal-name.change

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/worker.legal-address.add

Add Worker Personal Address

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

Add Worker Personal Email

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

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/worker.personal-communication.mobile.add

Add Worker Personal Pager

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

Change Worker Legal Address

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

Change Worker Personal Address

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

Change Worker Personal Email

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

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/worker.personal-communication.mobile.change

Change Worker Personal Pager

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

Remove Worker Legal Address

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

Remove Worker Personal Address

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

Remove Worker Personal Email

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

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/worker.personal-communication.mobile.remove

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/worker.work-assignment.standard-hours.change

Change Worker Type

  • POST/events/hr/v1/worker.work-assignment.worker-type.change

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/worker.custom-field.date.change/meta
  • POST/events/hr/v1/worker.custom-field.date.change

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/worker.person.custom-field.date.change/meta
  • POST/events/hr/v1/worker.person.custom-field.date.change

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

ADP API FAQs

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

API Directory
-
Jun 20, 2024

greytHR API Guide

greytHR API Directory

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

greytHR API Authentication

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

greytHR API API Objects, Data Models & Endpoints

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

Employee

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

Leave

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

Attendance

  • GET Get Attendance Summary for All Employees: https://api.greythr.com/attendance/v2/employee/insights?end={{EndDate}}&start={{StartDate}}
  • GET Get Employee Attendance Summary: https://api.greythr.com/attendance/v2/employee/{employee-id}/insights?end={{EndDate}}&start={{StartDate}}
  • GET Get Employee Attendance Summary: https://api.greythr.com/attendance/v2/employee/{employee-id}/insights?end={{EndDate}}&start={{StartDate}}
  • GET Get Employee Attendance Muster: https://api.greythr.com/attendance/v2/employee/{employee-id}/muster?end={{EndDate}}&start={{StartDate}}

Payroll

  • GET Get All Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/handentry
  • GET Get Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
  • GET Get Salary Repository Items: https://api.greythr.com/payroll/v2/salary/repository
  • POST Add Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
  • PUT Update Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
  • DELETE Delete Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
  • GET Get Salary Statement for a Month: https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}}
  • GET Get Salary Statement for an Employee for a Month: https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}}/{employee-id}
  • GET Get Employees Resettlement for a Month: https://api.greythr.com/payroll/v2/employees/resettlement/{payrollMonth}
  • POST Add Salary Revision: https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id}
  • GET Get Salary Revision History: https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id}/{status}
  • GET Get Salary Revision Difference: https://api.greythr.com/payroll/v2/salary/revision/difference/employees/{employee-id}
  • GET Get Attendance Snapshot details: https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id}
  • POST Save Attendance Snapshot: https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id}
  • DELETE Delete Attendance Snapshot: https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id}

List of Values

  • POST Get greytHR LOV: https://api.greythr.com/hr/v2/lov
  • POST Get greytHR Position/Category: https://api.greythr.com/hr/v2/lov
  • GET Get Bank Branch Details: https://api.greythr.com/hr/v2/lov/banks/{bankId}/branches
  • POST Add greytHR Org Entities: https://api.greythr.com/hr/v2/lov/org/entities

Documents

  • GET Get Employee Documents: https://api.greythr.com/employee/v2/emp-docs/{employeeId}/{categoryId}
  • GET Download Employee Documents: https://api.greythr.com/employee/v2/emp-docs/{employeeId}/{documentId}/{fieId}
  • POST Add Employee Document Category: https://api.greythr.com/employee/v2/emp-docs/category
  • POST Add Employee Document: https://api.greythr.com/employee/v2/employee-docs/{employeeId}/{category}

Users

  • POST Add New Users: https://api.greythr.com/user/v2/users
  • GET Get Users List: https://api.greythr.com/user/v2/users
  • GET Get Employee User ID: https://api.greythr.com/user/v2/users?userType=employee&userName=Employee Number
  • POST User SSO: https://api.greythr.com/user/v2/users/{userid}/auth

greytHR API Use Cases 

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

Top customers

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

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

greytHR API FAQs

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

How to integrate with greytHR API 

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

Get started with greytHR API 

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

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

API Directory
-
Jun 20, 2024

Zoho People API Guide

Zoho People API Directory

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

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

Zoho People API Authentication

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

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

Zoho People API Objects, Data Models & Endpoints

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

Forms API

  • POSTInsert Record API

https://people.zoho.com/people/api/forms/<inputType>/<formLinkName>/insertRecord?inputData=<inputData>

  • POSTInsert Record API for Adding Employees

https://people.zoho.com/people/api/forms/json/employee/insertRecord?inputData=<inputData>

  • POSTUpdate Record API

https://people.zoho.com/people/api/forms/<inputType>/<formLinkName>/updateRecord?inputData=<inputData>&recordId=<recordId>

  • GETGet Bulk Records API

https://people.zoho.com/people/api/forms/<formLinkName>/getRecords?sIndex=<record starting index>&limit=<maximum record to fetch>​

  • POSTAdd Department API

https://people.zoho.com/people/api/department/records?xmlData=<xmlData>

  • GETFetch Forms API

https://people.zoho.com/people/api/forms?

  • GETFetch Single Record API

https://people.zoho.com/people/api/forms/<formLinkName>/getDataByID?recordId=261091000000049003

  • GETFetch Single Record API (Section Wise)

https://people.zoho.com/people/api/forms/<formLinkName>/getRecordByID?recordId=<recordId>

  • GETGet Related Records API

https://people.zoho.com/people/api/forms/<formLinkName>/getRelatedRecords?sIndex=<sIndex>&limit=<limit>& parentModule=<parentModule>&id=<id>&lookupfieldName=<lookupfieldName>

  • GETSearch Records Based on Record Values

https://people.zoho.com/people/api/forms/<formLinkName>/getRecords?searchParams={searchField: '<fieldLabelName>', searchOperator: '<operator>', searchText : '<textValue>'}

  • GETGet Fields of Form API

https://people.zoho.com/people/api/forms/<formLinkName>/components?

Cases API

  • POSTAdd Case API

https://people.zoho.com/api/hrcases/addcase?categoryId=<Category ID>&subject=<subject>&description=<description>

  • GETView Case API

https://people.zoho.com/api/hrcases/viewcase?recordId=<Reord ID of the case>

  • GETView Case Listing API

https://people.zoho.com/api/hrcases/getRequestedCases?index=<index>&status=<status>

  • GETView List of Categories API

https://people.zoho.com/api/hrcases/listCategory?

Timesheet API

  • POSTCreate Timesheets API

https://people.zoho.com/people/api/timetracker/createtimesheet?user=<user>&timesheetName=<timesheetName>&description=<description>&dateFormat=<dateFormat>&fromDate=<fromDate>&toDate=<toDate>&billableStatus=<billableStatus>&jobId=<jobId>&projectId=<projectId>&clientId=<clientId>&sendforApproval=<sendforApproval>

  • POSTModify Timesheets API

https://people.zoho.com/people/api/timetracker/modifytimesheet?timesheetId=<timesheetId>&timesheetName=<timesheetName>&description=<description>&sendforApproval=<sendforApproval>&removeAttachment=<removeAttachment>

  • GETGet Timesheets API

https://people.zoho.com/people/api/timetracker/gettimesheet?user=<user>&approvalStatus=<approvalStatus>&employeeStatus=<employeeStatus>&dateFormat=<dateFormat>&fromDate=<fromDate>&toDate=<toDate>&sIndex=<sIndex>&limit=<limit>

  • GETGet Timesheets Details API

https://people.zoho.com/people/api/timetracker/gettimesheetdetails?timesheetId=<timesheetId>&dateFormat=<dateFormat>​

  • POSTApprove Timesheets API

https://people.zoho.com/people/api/timetracker/approvetimesheet?authtoken=<authtoken>&timesheetId=<timesheetId>&approvalStatus=<approvalStatus>&timeLogs=<timeLogs>&comments=<comments>&isAllLevelApprove=<isAllLevelApprove>​

  • POSTDelete Timesheets API

https://people.zoho.com/people/api/timetracker/deletetimesheet?timesheetId=<timesheetId>​

Onboarding API

  • POSTTrigger Onboarding API

https://people.zoho.com/api/<Employee|Candidate>/triggerOnboarding​

  • POSTAdd Candidate API

https://people.zoho.in/people/api/forms/json/Candidate/insertRecord?inputData=<inputData>​

  • POSTUpdate Candidate API

https://people.zoho.com/people/api/forms/<inputType>/Candidate/updateRecord?inputData=<inputData>&recordId=<recordId>

Leave API

  • POSTAdd Leave API

https://people.zoho.com/people/api/forms/<inputType>/<formLinkName>/insertRecord?inputData=<inputData>

  • POSTGet Record API

https://people.zoho.com/people/api/forms/leave/getDataByID?recordId=413124000068132003

  • PATCHCancel Leave API

https://people.zoho.com/api/v2/leavetracker/leaves/records/cancel/<record-id>

  • GETUser Report API

https://people.zoho.com/people/api/v2/leavetracker/reports/user

  • GETLeave Booked and Balance Report API

https://people.zoho.com/people/api/v2/leavetracker/reports/bookedAndBalance

  • GETLeave Bradford API

https://people.zoho.com/people/api/v2/leavetracker/reports/bradford

  • GETEncashment Report API

https://people.zoho.com/people/api/v2/leavetracker/reports/encashment

  • GETLOP Report API

https://people.zoho.com/people/api/v2/leavetracker/reports/lop

 

  • POSTAdd Leave Balance API

https://people.zoho.com/api/leave/addBalance?balanceData=<balanceData>&dateFormat=<dateFormat>

Attendance API

  • POSTBulk Import API

https://people.zoho.com/people/api/attendance/bulkImport?data=<JSONArray>

  • GETFetch Last Attendance Entries API

https://people.zoho.com/api/attendance/fetchLatestAttEntries?duration=5&dateTimeFormat=dd-MM-yyyy HH:mm:ss

  • POSTAttendance Check In Check Out API

https://people.zoho.com/people/api/attendance?dateFormat=<dateFormat>&checkIn=<checkin time>&checkOut=<checkout time>&empId=<employeeId>&emailId=<emailId>&mapId=<mapId>

  • POSTAttendance Entries API

https://people.zoho.com/people/api/attendance/getAttendanceEntries?date=<date>&dateFormat=<dateformat>&erecno=<erecno>&mapId=<mapId>&emailId=<emailId>&empId=<empId>

  • POSTAttendance User Report API

https://people.zoho.com/people/api/attendance/getUserReport?sdate=<sdate>&edate=<edate>&empId=<employeeId>&emailId=<emailId>&mapId=<mapId>&dateFormat=<dateFormat>

  • POSTEmployee Shift Mapping API

https://people.zoho.com/people/api/attendance/updateUserShift?dateFormat=<dateformat>&empId=<employee Id>&shiftName=<shift name>&fdate=<FromDate>&tdate=<toDate>

  • GETGetting Shift Details Of Employee API

https://people.zoho.com/people/api/attendance/getShiftConfiguration?empId=<employee Id>&emailId<email Id>=&mapId<Mapper ID>=&sdate<startDate>=&edate=<endDate>

  • GETGet Regularization Records API

https://people.zoho.com/people/api/attendance/getRegularizationRecords

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

Zoho People API Use Cases

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

Top customers

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

Zoho People API FAQs

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

How to integrate with Zoho People API

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

Get started with Zoho People API

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

API Directory
-
Jun 20, 2024

Ceridian Dayforce API Directory

Ceridian Dayforce API Directory

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

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

Ceridian Dayforce API Authentication

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

Ceridian Dayforce API Objects, Data Models & Endpoints

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

Dependents

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

Employee

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

Employment

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

Group

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

Location

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

Team

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

Time Off

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

Time Off Balance

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

Common Ceridian Dayforce API endpoints

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

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

  • GET/v1/Employees

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

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

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

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

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

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

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

Merge interacts with this API endpoint to...

  • GET/V1/Employees/{employee_id}

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

  • GET/v1/OrgUnits

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

  • GET/v1/EmployeeBalancePeriods

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

Ceridian Dayforce API Use Cases

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

Top customers

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

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

Ceridian Dayforce API FAQs

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

How to integrate with Ceridian Dayforce API

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

Get started with Ceridian Dayforce API 

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

API Directory
-
Jun 20, 2024

Oracle HCM API Directory

Oracle Fusion Cloud HCM API Directory

Oracle Fusion Cloud HCM is a cloud-based human resource solution provider which seeks to connect every aspect of the human resources process. It seeks to help enterprises with critical HR functions including, recruiting, training, payroll, compensation, and performance management to drive engagement, productivity, and business value. As a market leader, it allows developers to use Oracle REST APIs to access, view and manage data stored in Oracle Fusion Cloud HCM

Oracle Fusion Cloud HCM API Authorization

Oracle Fusion Cloud HCM API uses authorization to define which users can access the API and relevant information. To get this access, users need to have predefined roles and the necessary security privileges. Oracle’s REST APIs are secured by function and aggregate security privileges, delivered through job roles which are predefined. However, users can also create custom roles to provide access. Authorization and access to Oracle Fusion Cloud HCM API depends on the role of a person and the level of access offered. 

Oracle Fusion Cloud HCM API Objects, Data Models & Endpoints

To get started with Oracle Fusion Cloud HCM API, it is important to understand the end points, data models and objects and make them a part of your vocabulary for seamless access and data management.

Absences

  • Create an absence record

POST/hcmRestApi/resources/11.13.18.05/absences

  • Delete an absence record

DELETE/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}

  • Display absence type projected balance

POST/hcmRestApi/resources/11.13.18.05/absences/action/loadProjectedBalance

  • Display daily and shift details of the absence request

POST/hcmRestApi/resources/11.13.18.05/absences/action/absenceDailyDetailsBreakdown

  • Get all absence records

GET/hcmRestApi/resources/11.13.18.05/absences

  • Get an absence record

GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}

  • Get an absence type balance

POST/hcmRestApi/resources/11.13.18.05/absences/action/getAbsenceTypeBalance

  • Search existing absences

POST/hcmRestApi/resources/11.13.18.05/absences/action/findByAdvancedSearchQuery

  • Update an absence record

PATCH/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}

  • Create an attachment for an absence bid

POST/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments

  • Delete an attachment for an absence bid

DELETE/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}

  • Get all attachments for an absence bid

GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments

  • Get attachment for an absence bid

GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}

  • Update an attachment of an absence bid

PATCH/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}

  • Get all entitlement summary records

GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements

  • Get an entitlement summary record

GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements/{absenceEntitlementsUniqID}

  • Create an absence entry detail

POST/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails

  • Delete an absence entry detail

DELETE/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails/{PersonAbsenceEntryDetailId}

  • Get all absence entry details

GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails

  • Get an absence entry detail

GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails/{PersonAbsenceEntryDetailId}

  • Update an absence entry detail

PATCH/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails/{PersonAbsenceEntryDetailId}

Accomplishments

  • Get all profile tag details

GET/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions

  • Get all profile tag details

POST/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions

  • Get all profile tag details

DELETE/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}

  • Get all profile tag details

GET/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}

  • Get all profile tag details

PATCH/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}

Actions in Opportunity Marketplace

  • Create an action in opportunity marketplace

POST/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions

  • Get all actions in opportunity marketplace

GET/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions

  • Get an action in opportunity marketplace

GET/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}

Allocated Checklist

  • Allocate a checklist

POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/action/allocateChecklist

  • Allocate a new task

POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/allocateNewTask

  • Allocate a task from the task library

POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/allocateTaskFromTaskLibrary

  • Delete an allocated checklist

DELETE/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}

  • Force close an incomplete checklist

POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/forceCloseChecklist

  • Get all allocated checklists

GET/hcmRestApi/resources/11.13.18.05/allocatedChecklists

  • Get an allocated checklist

GET/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}

  • Update an allocated checklist

PATCH/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}

  • Delete an allocated task

DELETE/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}

  • Get all allocated tasks

GET/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks

  • Get an allocated task

GET/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}

  • Reopen a task

POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/action/reopenTask

  • Update an allocated task

PATCH/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}

  • Update the task status

POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/action/updateTaskStatus

Availability Patterns

  • Create an availability pattern

POST/hcmRestApi/resources/11.13.18.05/availabilityPatterns

  • Delete an availability pattern

DELETE/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}

  • Get all availability patterns

GET/hcmRestApi/resources/11.13.18.05/availabilityPatterns

  • Get an availability pattern

GET/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}

  • Update an availability pattern

PATCH/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}

Benefit Enrollment Opportunities

  • Get all enrollment opportunities

GET/hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities

  • Get an enrollment opportunity

GET/hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities/{PersonNumber}

Check out this detailed guide for all endpoints and data models

Oracle Fusion Cloud HCM API Use Cases

  • Seamless end-to-end HR process management including, hiring, onboarding, managing, and engaging workforce aligned with global compliances
  • Flexible programs to meet specific benefit requirements and the option to calculate and manage benefit plans for each employee group
  • Predictive analytics for workflow planning based on risk of leaving, managing team performance and retaining your best performers.
  • Advanced reporting helping teams create, manage, and visualize data from Microsoft Excel within Oracle HCM
  • Secure, self-service, mobile-responsive options for employees to manage personal data, PTO, payslips, and more

Top customers

12,000+ companies use Oracle Fusion Cloud HCM as their preferred HR tool, including:

  • ArcelorMittal S.A., a Luxembourg-based multinational steel manufacturing corporation
  • The Deutsche Bahn AG, the national railway company of Germany
  • Fujifilm Holdings Corporation, a Japanese company operating in photography, optics, office and medical electronics, biotechnology, and chemicals
  • Hormel Foods Corporation, an American food processing company
  • Sofigate, a leading business technology transformation company in the Nordics

Oracle Fusion Cloud HCM API FAQs

To better prepare for your integration journey with Oracle Fusion Cloud HCM API, here is a list of FAQs you should go through:

  • How to properly paginate in the API for Oracle Fusion Cloud HCM? Answer
  • What to do when Oracle Fusion HCM cannot get data from Rest api /workers? Answer
  • How to GET Employee Absences data from HCM Fusion by sending two dates in REST API query parameter? Answer
  • How to include multiple query parameters in HCM cloud rest Get call? Answer
  • How to get Workers by HireDate in Oracle HCM Cloud API? Answer
  • How to pull the latest record when there are multiple records with different dates in Oracle HCM? Answer
  • How to use SQL Developer with BIPublisher Oracle Cloud HCM? Answer
  • How do I get previous data with respect to effective date in Oracle HCM cloud reporting in a separate column? Answer
  • What applications that Integrate with Oracle's PeopleSoft Enterprise Human Capital Management? Answer
  • Where are Oracle Fusion Assets REST APIs? Answer

How to integrate with Oracle Fusion Cloud HCM API

To integrate with Oracle Fusion Cloud HCM API, ensure that you review the basics and have an understanding of REST APIs. Then get your Fusion Applications Account Info, including username and password. Configure your client, authorize and authenticate and then send an HTTP request and you’re all set to go. For a more detailed understanding of the best practices and a step-by-step guide to integrate with Oracle Fusion Cloud HCM API, check out this comprehensive guide

Get started with Oracle Fusion Cloud HCM API

While integrating with Oracle Fusion Cloud HCM API can help businesses seamlessly view, access and manage all HR data, the process of integration can be tricky. Right from building the integration in-house which requires API knowledge, developer bandwidth and much more to managing the integrations, there are several steps in the way. Naturally, the entire integration lifecycle can turn out to be quite expensive as well. Fortunately, companies today can leverage and integrate with a unified HRIS API like Knit, which allows them to connect with multiple HRIS applications, without the need to integrate with each one individually. Connect for a discovery call today to understand how you can connect with Oracle Fusion Cloud HCM API and several other HRIS applications faster and in a cost-effective manner. 

To get started with Knit for Oracle HCM or any other integrations setup a demo here

API Directory
-
Jun 20, 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

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
-
Jun 20, 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

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 19, 2024

Gusto API Directory

Gusto is an online payroll and HR solutions company. Backed by global expertise Gusto provides companies with one easy, integrated platform, to automate and simplify payroll, benefits, and HR processes. From time tracking, to performance management, analytics and even benefits administration, Gusto application enables businesses to make HR management seamless and streamlined, while saving hours and reducing human errors considerably. 

Gusto API Authentication, Pagination, Rate Limits

As a security first application, Gusto leverages OAuth2 for authentication. Gusto API integration uses two types of tokens for security and authentication. On the one side are organization level API tokens which can be accessed through the Developer Portal. Additionally, there are company level tokens (generally access tokens or refresh tokens), which are provided via the OAuth2 process. It is very important for developers building integrations with Gusto API to manage, store and maintain all tokens securely to prevent unauthorized authentication and access. 

Essentially, API tokens are used specifically for organization level endpoints, like creating a company, and cannot be used for company or employee level endpoints. For the latter, developers must focus on access tokens via OAuth2. To facilitate higher levels of security, Gusto API ensures that all endpoints which are authenticated via access tokens require a strict access token, which is reserved for access only to a single company. 

Gusto API endpoints support pagination. To use pagination, developers can add a page and a per parameter to their URL’s query string. The page can define the page number from where records are sought, and the per parameter dictates the number of records per page. In case the per parameter is left blank, by default 25 records will be returned. Each endpoint’s documentation reflects on whether or not it supports pagination. 

To ensure high performance throughput, Gusto API maintains an API rate limit of 200 requests per minute. This suggests that 200 API calls can be made within the 60 second time window, beyond which a violation will be evaluated. A 429 error, highlighting too many requests will be displayed if the rate limit is hit for an active integration and the request will be subsequently rejected. 

Gusto API Objects, Data Models & Endpoints

An understanding of the Gusto API objects, data models and endpoints is extremely important for developers seeking to build integrations with Gusto API. Some of the key endpoints include:

Companies

  • Create a company

POST https://api.gusto-demo.com/v1/provision

  • Get a company

GET https://api.gusto-demo.com/v1/companies/{company_id}

  • Get the custom fields of a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/custom_fields

Locations

  • Create a company location

POST https://api.gusto-demo.com/v1/companies/{company_id}/locations

  • Get company locations

GET https://api.gusto-demo.com/v1/companies/{company_id}/locations

  • Get a location

GET https://api.gusto-demo.com/v1/locations/{location_id}

  • Update a location

PUT https://api.gusto-demo.com/v1/locations/{location_id}

  • Get minimum wages for a location

GET https://api.gusto-demo.com/v1/locations/{location_uuid}/minimum_wages

Pay Schedules

  • Get the pay schedules for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules

  • Get a pay schedule

GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules/{pay_schedule_id}

  • Get pay periods for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_periods

  • Get pay schedule assignments for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules/assignments

Departments

  • Create a department

POST https://api.gusto-demo.com/v1/companies/{company_uuid}/departments

  • Get all departments of a company

GET https://api.gusto-demo.com/v1/companies/{company_uuid}/departments

  • Get a department

GET https://api.gusto-demo.com/v1/departments/{department_uuid}

  • Update a department

PUT https://api.gusto-demo.com/v1/departments/{department_uuid}

  • Delete a department

DELETE https://api.gusto-demo.com/v1/departments/{department_uuid}

  • Add people to a department

PUT https://api.gusto-demo.com/v1/departments/{department_uuid}/add

  • Remove people from a department

PUT https://api.gusto-demo.com/v1/departments/{department_uuid}/remove

Earning Types

  • Create a custom earning type

POST https://api.gusto-demo.com/v1/companies/{company_id}/earning_types

  • Get all earning types for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/earning_types

  • Update an earning type

PUT https://api.gusto-demo.com/v1/companies/{company_id}/earning_types/{earning_type_uuid}

  • Deactivate an earning type

DELETE https://api.gusto-demo.com/v1/companies/{company_id}/earning_types/{earning_type_uuid}

Payrolls

  • Get all payrolls for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/payrolls

  • Get a single payroll

GET https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}

  • Update a payroll by ID

PUT https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}

  • Prepare a payroll for update

PUT https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}/prepare

Contractor Payments

  • Get contractor payments for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/contractor_payments

  • Get a single contractor payment

GET https://api.gusto-demo.com/v1/companies/{company_id}/contractor_payments/{contractor_payment_id}

Company Benefits

  • Create a company benefit

POST https://api.gusto-demo.com/v1/companies/{company_id}/company_benefits

  • Get benefits for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/company_benefits

  • Get a company benefit

GET https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}

  • Update a company benefit

PUT https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}

  • Delete a company benefit

DELETE https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}

  • Get all benefits supported by Gusto

GET https://api.gusto-demo.com/v1/benefits

  • Get a supported benefit by ID

GET https://api.gusto-demo.com/v1/benefits/{benefit_id}

  • Get company benefit summary by company benefit id.

GET https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}/summary

  • Get benefit fields requirements by ID

GET https://api.gusto-demo.com/v1/benefits/{benefit_id}/requirements

Employees

  • Create an employee

POST https://api.gusto-demo.com/v1/companies/{company_id}/employees

  • Get employees of a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/employees

  • Get an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}

  • Update an employee

PUT https://api.gusto-demo.com/v1/employees/{employee_id}

  • Delete an onboarding employee

DELETE https://api.gusto-demo.com/v1/employees/{employee_id}

  • Get an employee's custom fields

GET https://api.gusto-demo.com/v1/employees/{employee_id}/custom_fields

  • Get employee time off activities

GET https://api.gusto-demo.com/v1/employees/{employee_uuid}/time_off_activities

Employee Employments

  • Get terminations for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/terminations

  • Get an employee rehire

GET https://api.gusto-demo.com/v1/employees/{employee_id}/rehire

  • Get employment history for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/employment_history

Employee Addresses

  • Get an employee's home addresses

GET https://api.gusto-demo.com/v1/employees/{employee_id}/home_addresses

  • Create an employee's home address

POST https://api.gusto-demo.com/v1/employees/{employee_id}/home_addresses

  • Get an employee's home address

GET https://api.gusto-demo.com/v1/home_addresses/{home_address_uuid}

  • Update an employee's home address

PUT https://api.gusto-demo.com/v1/home_addresses/{home_address_uuid}

  • Delete an employee's home address

DELETE https://api.gusto-demo.com/v1/home_addresses/{home_address_uuid}

  • Get an employee's work addresses

GET https://api.gusto-demo.com/v1/employees/{employee_id}/work_addresses

  • Create an employee work address

POST https://api.gusto-demo.com/v1/employees/{employee_id}/work_addresses

  • Get an employee work address

GET https://api.gusto-demo.com/v1/work_addresses/{work_address_uuid}

  • Update an employee work address

PUT https://api.gusto-demo.com/v1/work_addresses/{work_address_uuid}

  • Delete an employee's work address

DELETE https://api.gusto-demo.com/v1/work_addresses/{work_address_uuid}

Jobs and Compensations

  • Create a job

POST https://api.gusto-demo.com/v1/employees/{employee_id}/jobs

  • Get jobs for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/jobs

  • Get a job

GET https://api.gusto-demo.com/v1/jobs/{job_id}

  • Update a job

PUT https://api.gusto-demo.com/v1/jobs/{job_id}

  • Delete an individual job

DELETE https://api.gusto-demo.com/v1/jobs/{job_id}

  • Get compensations for a job

GET https://api.gusto-demo.com/v1/jobs/{job_id}/compensations

  • Create a compensation

POST https://api.gusto-demo.com/v1/jobs/{job_id}/compensations

  • Get a compensation

GET https://api.gusto-demo.com/v1/compensations/{compensation_id}

  • Update a compensation

PUT https://api.gusto-demo.com/v1/compensations/{compensation_id}

  • Delete a compensation

DELETE https://api.gusto-demo.com/v1/compensations/{compensation_id}

Employee Benefits

  • Create an employee benefit

POST https://api.gusto-demo.com/v1/employees/{employee_id}/employee_benefits

  • Get all benefits for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/employee_benefits

  • Get an employee benefit

GET https://api.gusto-demo.com/v1/employee_benefits/{employee_benefit_id}

  • Update an employee benefit

PUT https://api.gusto-demo.com/v1/employee_benefits/{employee_benefit_id}

  • Delete an employee benefit

DELETE https://api.gusto-demo.com/v1/employee_benefits/{employee_benefit_id}

  • Create year-to-date benefit amounts from a different company

POST https://api.gusto-demo.com/v1/employees/{employee_id}/ytd_benefit_amounts_from_different_company

Garnishments

  • Create a garnishment

POST https://api.gusto-demo.com/v1/employees/{employee_id}/garnishments

  • Get garnishments for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/garnishments

  • Get a garnishment

GET https://api.gusto-demo.com/v1/garnishments/{garnishment_id}

  • Update a garnishment

PUT https://api.gusto-demo.com/v1/garnishments/{garnishment_id}

Gusto API Use Cases

  • Automate employee time tracking (with flexible scheduling and remote work options), approval and accurate payroll creation
  • Rely on robust and customizable checklists for employee onboarding and ensure software provisioning with a few clicks
  • Automate workflow for performance management including self evaluation, manager review and career development sources with custom performance software
  • Leverage customizable reports, anonymous team surveys, automatic compliance alerts for holistic team insights
  • Create a payroll which runs on autopilot with automated calculations, compliances and much more

Top customers

Serving 300,000+ businesses, Gusto API is the preferred HR and payroll solutions provider for many global names, including:

  • Little Fish Accounting, a boutique CPA firm providing small businesses, entrepreneurs, and freelancers with accounting + tax support
  • ApproveMe.com, a document signing experience™ that helps businesses build better relationships with their signers
  • Snapbar, a company that develops intuitive, web-based products leveraging the power of photo and video
  • Heckler Design, a firm that creates beautifully simple, commercial-grade hardware and furniture for design-conscious consumers and businesses
  • Floyd Lee Locums, a company that provides an elite concierge experience to physicians, CRNAs, nurse practitioners, physician assistants, and other healthcare providers

Gusto API FAQs

Following is a list of FAQs that can help guide your Gusto API integration journey:

  • How do I get access to a sandbox environment to build Gusto API integration? Answer
  • How do I get API keys for Gusto API? Answer
  • Can I change the redirect URI for the API Keys? Answer
  • How long does it usually take to build an integration with Gusto API? Answer
  • Once an employee is created in Gusto via the API, what happens next? Answer
  • What’s required to obtain API Keys for Production? Answer
  • What debits can I expect to see via the Gusto API? Answer
  • Can I make test calls in production after my Gusto API integration has passed QA and launched? Answer
  • What are the error codes associated with Gusto API? Answer
  • How can I create a job ID and compensation for an employee in Gusto API? Answer
  • Does Gusto API have any sample codes I can use to get started on? Answer
  • What kind of support will I get when building my integration? Answer

Common Integrations with Gusto API 

Undoubtedly, there are several categories of applications which can benefit from integrating with Gusto API. Listing a few for developers to get an idea:

  • ATS applications to push newly hired candidate data
  • Performance management systems to get access to employee rosters and information
  • HR analytics platforms to get access to employee data, including payroll, compensation, etc. 
  • Benefits applications to facilitate accurate deductions and benefits administration

How to integrate with Gusto API 

To commence your integration journey with Gusto API, it is important to create a developer account. You can sign up for an account here. Once you sign up for a developer account, the next steps are quite streamlined. It involves accepting the terms of service, setting up the account, creating the application to get access to your unique Gusto API keys. As a best practice, it is ideal to go through the detailed documentation and guides offered by Gusto API to understand the diverse aspects of integration. You can check out the documentation resource to answer all questions you may have, here. Gusto API also offers a sandbox functionality to test and demo your work, before making a firm commitment.  

Get started with Gusto API 

Developers can build Gusto API integration for their applications following the steps mentioned in the section above and by leveraging the documentation shared. However, building one integration can take up to 4-6 weeks on an average, utilizing a lot of developer bandwidth, becoming a cost intensive project. In case you need to build more than one HRMS integration, leveraging a unified API like Knit is ideal. A unified API adds an additional layer of abstraction on top of the API, ensuring that developers only have to integrate with one unified API to connect with several HRMS applications supported by the unified API. To understand how a unified API like Knit can help your integration journey, book a demo today. 

API Directory
-
Mar 19, 2024

Paylocity API Directory

Paylocity is a market leader in providing cloud-based payroll and human capital management software. It provides intuitive and easy to use products that enable businesses to automate and streamline their HR and payroll processes, facilitate better hiring practices and build a culture of retention and engagement. To facilitate connections with different applications, Paylocity offers  open, developer-friendly APIs. With automation at the core, Paylocity API ensures that updates, i.e. when payroll is processed or when there is any change in the employee base (hire, transfer, termination) webhooks are pushed to reflect the changes.

This article will help you understand how Paylocity API functions, how developers can authenticate and access the same. Furthermore, it will highlight the different endpoints, use cases and FAQs that are integral to a smooth integration journey. Finally, it will discuss the common integration use cases for Paylocity API, focusing on the category of applications that can seamlessly integrate with Paylocity for business impact. 

Paylocity API Authentication, Filtering, Rate Limits

To ensure safe and limited access, Paylocity API leverages OAuth2 for authentication using Client Credentials. In this form of authentication, each API call to Paylocity API is accompanied by a HTTP Header named Authorization, along with a bearer token (with limited time validity), from the Paylocity Identity Provider. The token for authentication only has a life of 60 minutes and expires post that. Using an expired token will lead to a failed response. To receive the token, you must have client_id and secret. 

API filtering is quite an important attribute when it comes to ensuring that only relevant data is exchanged and also increases the speed of exchange. Paylocity API filtering works on the principle of request-response communication. Whenever an API request is made to the server, the filter criteria must be specified. Subsequently, once the server processes this request, the filter is applied and only relevant data, which meets the criteria is sent back.  

To prevent overuse or overconsumption of resources, Paylocity API has set rate limits, permitting up to 40,000 calls per hour. If more requests are made than the set limit, a 403 forbidden error message appears, indicating overuse. To prevent overuse of API calls and to stay within the rate limit, developers can optimize their code to minimize the API calls made per minute, by caching data, removing redundant requests and making API calls only when necessary. Implementing rate limiting logic, and retry mechanism can also help in error handling. 

Paylocity API Objects, Data Models & Endpoints

To integrate with Paylocity API, it is important to have an understanding of the objects, data models and endpoints you will be working with. Here’s a quick starting point:

  • Add / Update Deduction (sends new or updated employee deduction information directly to Paylocity Payroll/HR solution)

POST https://apisandbox.paylocity.com/api/v1/deduction

  • Delete deduction for deduction code / start date

DELETE https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}/{startDate}

  • Get All Deductions (returns all deductions for the selected employee)

GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions

  • Get Deduction for Deduction Code (returns records for a specific deduction for the selected employee)

GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}

  • Add Employee to Onboarding (sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process)

POST https://apisandbox.paylocity.com/api/v1/companies/{companyId}/onboarding/employees

  • Get Local Tax for Tax Code (returns local tax information for the specific tax code for the selected employee)

GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}

  • Update Local Tax (sends updated local tax code information for the selected employee)

PUT https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}

  • Delete Local Tax for Tax Code (deletes the local tax code from Paylocity Payroll/HR solution)

DELETE https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}

  • Get All Local Taxes (returns all local tax information for the selected employee)

GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes

  • Add Local Tax (sends new local tax information directly to Paylocity Payroll/HR solution)

POST https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes

  • Add/update additional rates (sends new or updated employee additional rates information directly to Paylocity Payroll/HR solution)

PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/additionalRates

  • Get All Company Codes

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/codes/{codeResource}

  • Get All Custom Fields

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/customfields/{category}

  • Get All Direct Deposit (returns main direct deposit and all additional direct deposits for the selected employee)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/directDeposit

  • Get All Earnings (returns all earnings for the selected employee)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings

  • Add/Update Earning (sends new or updated employee earnings information directly to Paylocity Payroll/HR solution)

PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings

  • Get Earning by Earning Code and Start Date (returns the single earning with the provided earning code and start date for the selected employee)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate}

  • Delete Earning by Earning Code and Start Date

DELETE https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate}

  • Get Earnings by Earning Code (returns all earnings with the provided earning code for the selected employee)

GET

https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}

  • Add/update emergency contacts (sends new or updated employee emergency contacts directly to Paylocity Payroll/HR solution)

PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/emergencyContacts

  • Add/update employee's benefit setup (sends new or updated employee benefit setup information directly to Paylocity Payroll/HR solution)

PUT  https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/benefitSetup

  • Get all employees (returns employee data currently available in Paylocity Payroll/HR solution)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees

  • Add new employee (sends new employee data directly to Paylocity Payroll/HR solution)

POST https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees

  • Get employee (returns employee data currently available in Paylocity Payroll/HR solution)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}

  • Update employee (updates existing employee data in WebPay)

PATCH https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}

  • Get sensitive data

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/sensitivedata

  • Add/update sensitive data (sends new or updated employee sensitive data information directly to Paylocity Payroll/HR solution)

PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/sensitivedata

  • Gets Retirement Contributions (provides deferrals, loan payments, employer match)

GET https://dc1demogwext.paylocity.com/apiHub/benefits/v1/companies/{companyId}/retirementPlans/{planId}/checks/{checkDate}

Paylocity API Use Cases

  • Access real-time, visual representation of information through reports, analytics, and dashboards for tracking essential metrics, spotting trends, and making informed decisions based on data.
  • Simplify the gathering of information, documents, and task management across various users and environments.
  • Easily create tailored employee appreciation initiatives, oversee rewards and budgets, and monitor program performance instantly.
  • Measure employee engagement levels to gain insight into potential time and cost efficiencies.
  • Gather input from colleagues, supervisors, and team members for comprehensive 360-degree feedback. Utilize talent assessment frameworks like the 9-box grid.
  • Delegate training tasks using an extensive course library, upload custom materials, or empower employee experts to develop and distribute training through our online collaboration platform, Community.
  • Reduce manual input by automatically incorporating reimbursements into employee paychecks.
  • Access consolidated global payroll data in real-time for over 100 countries through our integrated payroll system.

Top customers

36,000+ customers use Paylocity for the HR and payroll needs, including:

  • Meyer Distributing, a leader in automotive specialty products marketing and distribution
  • Noble House, a curated collection of award-winning boutique hotels, luxury resorts
  • Crafton Tull, an engineering, design, and surveying firm 
  • HP Piping Solutions, manufacturers and suppliers of high-pressure mud piping, mud gas separators and other drilling-related products
  • BASIS.ed, a for-profit education management organization based in Scottsdale, Arizona
  • Momentus Technologies, a global provider of industry leading venue and event management solutions

Paylocity API FAQs

A quick glance on the common FAQs that developers have about Paylocity API can help you accelerate your integration journey:

  • How to get the REST API cURL Token for Paylocity? Answer
  • How to retrieve an employee's PTO from Paylocity API? Answer
  • How to get the Paylocity API Access Token? Answer
  • How to get the access token for Paylocity Web API in Node.js without getting an error "invalid_client"? Answer
  • How to use Paylocity API to get employee department? Answer
  • How to address the issue of pulling data from Paylocity API? Answer
  • How to get employee custom fields from Paylocity API? Answer
  • How to extract data from Paylocity API using cloud data fusion? Answer
  • How to get Paylocity API Access using Python? Answer
  • What are the requirements to get production credentials and launch Paylocity API integration? Answer
  • What authentication method do you use to access Paylocity APIs? Answer
  • How do I find Paylocity APIs that fit my use case? Answer
  • Is there a cost for using Paylocity’s APIs? Answer

Common Integrations with Paylocity API 

Here’s a non-exhaustive list of applications (categories), which can easily integrate with Paylocity API to facilitate easy exchange of employee relevant information and further their impact, without the need to duplicate information upload:

  • Benefits administration systems to ensure correct allocation and deduction in employee payrolls
  • Application tracking systems for seamless onboarding, payroll setup, etc. 
  • Payroll and accounting systems to facilitate compensation management 
  • Active employee directories, ensuring all employee data is updated for consumption 
  • Workforce planning tools to set hiring and retention strategy 

How to integrate with Paylocity API 

Paylocity offers several APIs for different use cases. Therefore, as the first step, you need to understand your integration needs and then identify the right API and endpoints to connect with. The next step is to get the access token to access the sandbox or the demo environment (oAuth credentials). Once you get the access, leverage guides like this one to build, test and go-live with your Paylocity API integration. 

Get started with Paylocity API 

As visible from the section above, integration with Paylocity API involves several steps and knowledge transfer across several documentation guides. Fortunately, unified API providers like Knit, make it very easy for developers to integrate with Paylocity and multiple other HRIS applications in a very short time. Adding an additional abstraction layer to the API infrastructure, Knit’s unified HRIS API ensures that customers only have to integrate once and they can then connect with all other HRIS applications from there. To understand more about how a unified HRIS API can help you significantly optimize your integration building and management process, book a discovery call today

API Directory
-
Mar 19, 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). 

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. 

API Directory
-
Oct 30, 2023

Getting Started with Greenhouse API Integration: Developer's Guide to Integration

In this article, we will discuss a quick overview of popular Greenhouse APIs, key API endpoints, common FAQs and a step-by-step guide on how to generate your Greenhouse API keys as well as steps to authenticate it. Plus, we will also share links to important documentation you will need to effectively integrate with Greenhouse.

Overview of Greenhouse API

Imagine having the ability to revolutionize your hiring processes, making them more efficient, data-driven, and tailored to your organization's unique needs. That's where the Greenhouse API can help you.

Greenhouse, an applicant tracking software (ATS) and hiring platform. It is a powerful tool that empowers organizations to foster fair and equitable hiring practices. 

With a proven track record of assisting over 7500 companies, Greenhouse offers a comprehensive recruitment tool suite, valuable resources, expert guidance, and robust support to help businesses scale and optimize their hiring processes.

Whether you're a developer looking to integrate Greenhouse into your company's tech stack or an HR professional seeking to streamline your hiring workflows, the Greenhouse API offers a world of possibilities.

Let's explore common Greenhouse APIs, popular endpoints, and how to generate your Greenhouse API keys. 

Common Greenhouse APIs

The Greenhouse API offers a wide range of endpoints to interact with various aspects of the Greenhouse platform. Here are 5 most commonly used Greenhouse APIs:

1. Harvest API

The Harvest API serves as a key gateway to your Greenhouse data, offering extensive accessibility. Initially designed for data export, this versatile API goes beyond its core function.
It empowers users to carry out a range of actions, including - 

  • updating candidate information
  • adding attachments to candidate profiles
  • merging candidate profiles
  • managing the application process (advancing, hiring, or rejecting them).

Some endpoints include:

  • GET: List applications to access candidate applications from Greenhouse Recruiting
  • DELETE: Delete application to delete candidate applications from the platform

Authentication: Basic Auth over HTTPS

Job Board API

Through the Greenhouse Job Board API, you gain effortless access to a user-friendly JSON representation of data about your company's offices, departments, and published job listings.
With direct access to this raw data, you can design career pages according to your specific needs, generate department-specific content, and unlock a multitude of other possibilities tailored to your preferences.
Additionally, they offer support for JSONP callbacks and provide a POST method, enabling you to construct customized online job application forms tailored to your specific needs.

Some endpoints include:

  • GET: List jobs to access job post information and display job posts on API-driven career site
  • POST: Submit application to enable potential candidates to submit their application for open positions

Authentication: Basic Auth

Click here for more information.

Assessment API

Primarily used for Greenhouse API to create and conduct customized tests across coding, interviews, personality tests, etc. to check the suitability of the candidate for a particular role. You can leverage tests from third party candidate testing platforms as well and update status for the same after the completion by candidate. 

Some endpoints include:

  • GET https://www.testing-partner.com/api/list_tests to see a list of available tests for the candidate
  • GET https://www.testing-partner.com/api/test_status?partner_interview_id=12345 to check the current status of a take home test

Authentication: HTTP Basic Authentication over HTTPS

Ingestion API

The Ingestion API offers the capability to acquire candidate leads from third-party platforms and also provides visibility into the current stages of applications within the system.
Through this API, you gain the ability to:

  • send candidates from their applications to Greenhouse.
  • fetch the current stage and status of candidates.
  • retrieve information about jobs on which the Greenhouse users have operational permissions.

Some endpoints include:

  • GET https://api.greenhouse.io/v1/partner/candidates to retrieve the data for a particular candidate
  • POST https://api.greenhouse.io/v1/partner/candidates to create one or more candidate
  • GET https://api.greenhouse.io/v1/partner/jobs to retrieve jobs visible to current use 

Authentication:  OAuth 2.0 and Basic Auth

Onboarding API

Greenhouse Onboarding API allows you to seamlessly retrieve and update employee data, as well as essential company information, for a smooth onboarding process.

This API only supports GraphQL and not the traditional REST API approach. The key endpoints are in GET, PUT, POST, PATCH, and DELETE.

Authentication: HTTP Basic Authentication over HTTPS

Integrate with Greenhouse API 10X faster. Learn more

How to get a Greenhouse API token?

To make requests to Greenhouse's API, you would need an API Key. Here are the steps for generating an API key in Greenhouse:

Step 1: Go to the Greenhouse website and log in to your Greenhouse account using your credentials.

Step 2: Click on the "Configure" tab at the top of the Greenhouse interface.


Step 3: From the sidebar menu under "Configure," select "Dev Center."

Step 4: In the Dev Center, find the "API Credential Management" section.

Step 5: Click on "Create New API Key."

Step 6: Configure your API Key

  1. Select the API type you want to use.
  2. Give your API key a description that helps you identify its purpose or the application it will be used for.
  3. Specify the permissions you want to grant to this API key by clicking on “Manage Permissions”. Greenhouse provides granular control over the data and functionality that can be accessed with this key. You can restrict access to specific parts of the Greenhouse API to enhance security.

Step 7: After configuring the API key, click "Create" or a similar button to generate the API token. The greenhouse will display the API token on the screen. This is a long string of characters and numbers.

Step 8: Copy the API token and store it securely. Treat it as sensitive information, and do not expose it in publicly accessible code or repositories.

Important: Be aware that you won't have the ability to copy this API Key again, so ensure you store it securely.

Once you have obtained the API token, you can use it in the headers of your HTTP requests to authenticate and interact with the Greenhouse API. Make sure to follow Greenhouse's API documentation and guidelines for using the API token, and use it according to your specific integration needs.

Always prioritize the security of your API token to protect your Greenhouse account and data. If the API token is compromised, revoke it and generate a new one through the same process. 

Now, let’s jump in on how to authenticate for using the Greenhouse API.

How to authenticate Greenhouse API?

To authenticate with the Greenhouse API, follow these steps:

Step 1: In your HTTP requests to the Greenhouse API, you need to include the API token in the headers. Use the "Authorization" header to pass your API token as follows - 

```

Authorization: Basic YOUR_API_TOKEN

```

Step 2: With the API token included in the headers, you can now make authenticated requests to the Greenhouse API. The token serves as your authentication credential, granting you access to the API endpoints and data according to the permissions associated with the token.

Remember to follow Greenhouse's API documentation and guidelines for best practices, and ensure that you protect your API token from unauthorized access to maintain the security of your Greenhouse account and data.

Common FAQs on Greenhouse API

Check out some of the top FAQs for Greenhouse API to scale your integration process:

1. Is there pagination support for large datasets?

Yes, many API endpoints that provide a collection of results support pagination.
When results are paginated, the response will include a Link response header (as per RFC-5988) containing the following details:

  • "next": This corresponds to the URL leading to the next page.
  • "prev": This corresponds to the URL leading to the previous page.
  • "last": This corresponds to the URL leading to the last page.

When this header is not present, it means there is only a single page of results, which is the first page.

2. Are there rate limits for API requests?

Yes, Greenhouse imposes rate limits on API requests to ensure fair usage, as indicated in the `X-RateLimit-Limit` header (per 10 seconds).
If this limit is exceeded, the API will respond with an HTTP 429 error. To monitor your remaining allowed requests before throttling occurs, examine the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers. 

3. Does Greenhouse have a sandbox?

Yes, Greenhouse provides a sandbox that enables you to conduct testing and simulations effectively.

The sandbox is created as a blank canvas where you can manually input fictitious data, such as mock job listings, candidate profiles, or organizational information.

Refer here for more info.

4. What are the challenges of building Greenhouse API integration?

Building Greenhouse API integration on your own can be challenging, especially for a team with limited engineering resources. For example,

  • It can take around 4 weeks to up to 3 months to fully plan, build and deploy Greenhouse integration. And ongoing maintenance and monitoring of the API can take ~10 hours each week — all the time that could be invested into improving your core product features. To calculate the cost yourself, click here
  • The data models of Greenhouse API may not match the data models from other ATS applications (if you are building multiple ATS integrations). In that case, you need to spend additional bandwidth decoding and understanding nuances of Greenhouse API which again is not very productive use of in-house engineering resources.
  • You need to design and implement workflows to serve specific use cases of your customers using Greenhouse APIs.
  • The API is updated frequently, so you need to always keep an eye out for the changes to make sure your user experience is not diminished.
  • Handle integration issues manually as and when they arise.

5. When should I consider integrating with Greenhouse API?

Here are some of the common Greenhouse API use cases that would help you evaluate your integration need:

  • Access job listings from 1000+ job boards with recommendations based on historical trends
  • Create scorecard of key attributes for fair and consistent evaluation
  • Automate surveys for candidate experience and enable candidate to self schedule interviews
  • Access 40+ reports and dashboard snapshots
  • Automated tasks and reminders for smooth onboarding
  • Structured process for paperwork
  • Easy reports to understand onboarding trends

Ready to build?

If you want to quickly implement your Greenhouse API integration but don’t want to deal with authentication, authorization, rate limiting or integration maintenance, consider choosing a unified API like Knit.

Knit helps you integrate with 30+ ATS and HR applications, including Greenhouse, with just a single unified API. It brings down your integration building time from 3 months to a few hours.

Plus, Knit takes care of all the authentication, monitoring, and error handling that comes with building Greenhouse integration, thus saving you an additional 10 hours each week.

Ready to scale? Book a quick call with one of our experts or get your Knit API keys today. (Getting started is completely free)
API Directory
-
Sep 21, 2023

Get Started with Darwinbox API: Complete Integration Guide

DarwinBox is a cloud based HRMS portal built to support the entire employee lifecycle from hire to retire. Serving 750+ organizations with a total of 2Mn+ employees, DarwinBox is powered by artificial intelligence and machine learning to automate HR processes for smooth execution. DarwinBox API allows users to seamlessly access data stored on the platform or import data into it. With a focus on privileged access, DarwinBox provided access only on a request-basis. 

DarwinBox API endpoints

DarwinBox API endpoints are secured by a deal factor auth mechanism, supported by end point authorization. The platform has different modules to support different HR functions and each one has several subsections and associated endpoints. Some of the top DarwinBox API endpoints include: 

Employee Core Module Inbound APIs

  • POST Validate Employee Username / Password
  • POST Validate Custom SSO Token
  • POST Add Standard Documents
  • POST Add/Update Email ID
  • POST Add/Update Education Details
  • POST Add/Update Past Work Details

Employee Core Module Outbound APIs

  • POST Fetch Employee Data (Full Load)
  • POST Fetch Deleted Employees
  • POST Fetch Custom Workflow Details
  • POST Fetch Organization Masters - Employee Type
  • POST Fetch Position History
  • POST Fetch Completed Training Review Flows

Recruitment Module APIs

  • POST Fetch Job List V3
  • POST Fetch Candidate Data - Bulk V3
  • POST Reject Candidate V3
  • POST Add Tags to Candidate Profile V3

Onboarding Module APIs

  • POST Background Verification - Fetch Candidate List V2
  • POST Background Verification - Download Form
  • POST Background Verification - Submit Verification Report V2

Attendance and Timesheets Module APIs

  • POST Fetch Attendance Status (Monthly) V1
  • POST Fetch Attendance Status (Date Range) V1
  • POST Fetch Weekly Off & Shift Assignment
  • POST Fetch Attendance Requests Approved Between Given Dates
  • POST Fetch OT Approved Between Given Dates
  • POST Add Attendance Punches
  • POST Employee Timesheet Datewise

Leave Module APIs

  • POST Update Leave Status API
  • POST Fetch Leave Transactions API
  • POST Fetch Holidays list
  • POST Fetch Leave Balance
  • POST Import Leaves API
  • POST Fetch Leave Encashment details

Performance Module APIs

  • POST Fetch Talent profile
  • POST Update Achievement
  • POST Get Employee Promotion History
  • POST Get Job Level History

Compensation Module APIs

  • POST Import Component Payslip
  • POST Fetch Employee CTC Data
  • POST Fetch Employee Global CTC Data
  • POST Fetch Global Extra Payments
  • POST Fetch Monthly PF details
  • POST Fetch Salary Register Details
  • POST Fetch CTC Breakup Computation
  • POST Fetch Payroll Custom Report Data

Expenses Module APIs

  • POST Fetch Expense Details

Recognition Module APIs

  • POST Fetch Redemption Points
  • POST Update Redemption Transaction
  • POST Fetch Budget History
  • POST Fetch Reward Activity
  • POST Fetch Redemption History
  • POST Fetch Nomination Activity

Travel Module APIs

  • POST Fetch Approved Travel Requests
  • POST Fetch Cancelled Travel Requests
  • POST Fetch Advance Travel
  • POST Fetch Travel Booking Report

Vibe and Pulse APIs

  • POST Fetch Pulse Updates

HR Documents APIs

  • POST Push HR documents

DarwinBox API use cases

  • Core HR with employee master, custom workflows, HR documents & more
  • Employee helpdesk with auto ticket assignment, closure & feedback, SLA configuration, 1-on-1 chat
  • Rewards & recognition via 100% configurable programs, budget control, redemption platform integration
  • Time & attendance with touchless attendance, granular policy configuration, one-view dashboards
  • Digital employee onboarding with AI based doc validation
  • Performance management through OKRs, continuous feedback, role-based dashboards, talent development & more
  • Recruitment support with candidate sourcing, advanced job, candidate & offer management, reports
  • Travel & expense management with smart OCR capture, automated spend approval & budget controls, analytics
  • Employee engagement with an organizational social network, pulse, polls, surveys, e-noticeboards, custom groups

Top customers

  • Zee Media, news broadcasting company of the Essel Group
  • Rupeek, a pioneer among gold finance companies in India
  • MobiKwik, an Indian payment service provider
  • Duroflex, India's most trusted sleep solutions expert
  • Tata CLiQ, an Indian e-commerce company

How to integrate with DarwinBox API

Check out this detailed documentation to get started with DarwinBox API integration. 

Get started with DarwinBox API

The pricing for DarwinBox API is not available publicly. You can request a quote here and choose the module that works best for you. However, you can get started with Knit, one API for all your integrations. Sign up with Knit, starting at $1500 for up to 5 connected customers. Claim your free access here

API Directory
-
Sep 21, 2023

Get Started with Lever API

Lever is a leading recruitment software that combines the power of ATS and CRM to help hire top talent for companies. It provides a complete talent management solution to facilitate sourcing, nurturing and interviews. It helps companies ensure inclusivity in recruitment while eliminating bias in hiring with its tools including Lever Hire, Lever Nurture, Lever Analytics. 

All data in Lever API is sent and received as JSON over HTTPS and unencrypted HTTP is not supported. Lever API uses basic auth for authentication using API key as the username or OAuth. 

Lever API endpoints

Top Lever API endpoints to access particular information are as follows:

  • GET https://api.lever.co/v1/candidates to use an access token
  • GET /opportunities/:opportunity/applications/:application to retrieve full record of a single application
  • GET /opportunities/:opportunity/applications to list all applications for a candidate
  • GET /archive_reasons/:archive_reason to retrieve a single archive reason
  • GET /archive_reasons to list all archive reasons in Lever account
  • GET /audit_events to list all audit events
  • GET /contacts/:contact to retrieve a single account
  • GET /opportunities/:opportunity/feedback/:feedback to retrieve a feedback form
  • GET /opportunities/:opportunity/feedback to list all feedback for a candidate for this opportunity
  • GET /feedback_templates/:feedback_template to retrieve a feedback template
  • GET /feedback_templates to list all feedback templates
  • GET /opportunities/:opportunity/files/:file/download to download a file
  • POST /opportunities/:opportunity/interviews to create a new interview
  • POST /opportunities/:opportunity/notes to create a note and add it to a candidate profile
  • POST /opportunities/:opportunity/addLinks to update contact links by opportunity
  • POST /opportunities/:opportunity/removeTags to remove tags from an opportunity
  • GET /postings/:posting to retrieve a single posting
  • GET /postings to list all postings
  • POST /postings to create a posting

Check out this detailed documentation for more endpoints.

Lever API use cases

  • Candidate relationship building with easy-to-use nurturing capabilities
  • Collaborative interviews with visibility into the entire candidate pipeline and a single location for every candidate interaction
  • Hiring and recruiting insights with out-of-the-box, actionable analytics 
  • Inclusive hiring to set and assess DEI strategies and overcome unconscious
  • Candidate record maintenance to keep every candidate’s information and all correspondence

Lever API FAQs

Check out the top FAQs for Lever API to help you get started

  1. What is the difference between the Lever API and Postings API? Answer
  2. Does the Lever API archive encompass all candidates that have been either rejected or somehow stopped the interview process? Answer
  3. Are stages in Lever API customized by each company? Answer
  4. How do I add global tags to a Lever account? Answer
  5. Are tags customized by each company in Lever? Answer

How to integrate with Lever API

To learn how you can get started with Lever API integration, check out this detailed guide.

Get started with Lever API

To get access to Lever pricing for integration, you can get a free quote here. However, you can get started with Knit, one API for all your integrations. Sign up with Knit, starting at $1500 for up to 5 connected customers. Claim your free access here

API Directory
-
Sep 20, 2023

Get Started with SuccessFactors API

SuccessFactors by SAP is a leading cloud human capital and experience management platform. It provides cutting edge solutions for core HR (payroll), talent management (performance, compensation, recruitment, onboarding) along with reporting and analytics. SAP SUccessFactors can be deployed in hybrid or full cloud variants. Founded in 2001, SuccessFactors was acquired by SAP in 2012. 

SuccessFactors API endpoints

Some endpoints for SAP SuccessFactors API include:

  • GET /odata/v2/Attachment(1L) 
  • GET /odata/v2/Attachment?$filter=module eq ‘'EMPLOYEE_PROFILE'
  • GET, URL: odata/v2/Country
  • GET, URL: odata/v2/PickListV2
  • POST, URL: odata/v2/TimeZone
  • DELETE, URL: odata/v2/Currency
  • POST /odata/v2/upsert
  • POST /odata/v2/UserBadges
  • MERGE, URL: odata/v2/Country
  • MERGE, URL: odata/v2/CurrencyConversion
  • DELETE /odata/v2/Background_InsideWorkExperience
  • POST /odata/v2/Attachment

Here’s a guide for more information.

SuccessFactors API use cases

  • Facilitates embedded engagement and automation to help companies source, engage and hire best talent
  • Ensures engagement among internal and external new hires for productivity from day one
  • Provides multiple human capital management tool to leverage and manage employee master data
  • Ensures bias free performance evaluations
  • Aligns employee goals to business targets
  • Helps in identifying and nurturing top talent
  • Facilitates HR analytics and workforce planning to align HR with corporate strategy and identify attrition risks
  • Centralizes document management with process harmonization
  • Optimizes performance, recognition, learning and development

Top customers

  • Microsoft, a multinational technology corporation
  • Purolator Inc., a Canadian courier 
  • Swiss Re, a reinsurance company based in Zürich
  • Milliken & Company, an American industrial manufacturer 

SuccessFactors API FAQs

Here are some of the top SuccessFactors FAQs that can help you understand this integration better:

  1. What are the available APIs for SuccessFactors? Answer
  2. How to use SuccessFactors APIs for custom integrations? Answer
  3. How to address SSIS Odata Source feed error while executing a task using SuccessFactors as source? Answer
  4. How to integrate SuccessFactors and S4HANA using S4 SDK? Answer
  5. How to pull all data via API from successfactors? Answer
  6. What is the Successfactors API limit number of records return per request? Answer
  7. How to get CandidateID from SuccessFactors Career (recruitment) site? Answer
  8. How to filter out all Upsertable entities in successfactors using postman? Answer
  9. How to retrieve snapshot data using SuccessFactors Compound Employee API? Answer
  10. How to set up OAuth Authentication in SAP SuccessFactors? Answer
  11. How to get the top 1 element when calling the API of SAP Successfactor using RestAssured? Answer

How to integrate with SuccessFactors API

To get started with SAP SuccessFactors  API, click here for more information.

Get started with SuccessFactors API

SAP SuccessFactors Employee Central pricing starts from 6.3 USD per CLD_S0071 / Month and you can request a custom quote based on your requirements. However, you can get started with Knit, one API for all your integrations. Sign up with Knit, starting at $1500 for up to 5 connected customers. Claim your free access here

API Directory
-
Jul 31, 2023

Guide to Integrating with Rippling API

Rippling is a workforce management platform which enables companies to manage their IT, HR and Finance functions with one solution. It offers payroll, benefits, expenses, corporate cards, computers, apps, services among others. It seeks to automate manual work across workforce management like onboarding, by enabling companies to set up payroll, health insurance, corporate card, work computer, and third-party apps, etc. for new employees with a single click. 

With Rippling API, customers and partners can access company and employee data to power their workforce management. Rippling API follows OAuth 2.0 for authorization and authentication. 

Rippling API endpoints

Let’s quickly look at the endpoints for Rippling API across fields like companies, employees, groups, etc. 

Companies

  • GET https://api.rippling.com/platform/api/companies/current
  • GET https://api.rippling.com/platform/api/departments
  • GET https://api.rippling.com/platform/api/work_locations
  • GET https://api.rippling.com/platform/api/custom_fields
  • GET https://api.rippling.com/platform/api/teams
  • GET https://api.rippling.com/platform/api/levels
  • GET https://api.rippling.com/platform/api/company_leave_types
  • GET https://api.rippling.com/platform/api/company_activity

Employees

  • GET https://api.rippling.com/platform/api/employees
  • GET https://api.rippling.com/platform/api/employees/{employeeId}
  • GET https://api.rippling.com/platform/api/employees/include_terminated

Groups

  • GET https://api.rippling.com/platform/api/groups
  • POST https://api.rippling.com/platform/api/groups
  • PUT https://api.rippling.com/platform/api/groups/{groupId}
  • PATCH https://api.rippling.com/platform/api/groups/{groupId}
  • DELETE https://api.rippling.com/platform/api/groups/{groupId}

SAML

  • GET https://api.rippling.com/platform/api/saml/idp_metadata

Current User

  • GET https://api.rippling.com/platform/api/me

ATS

  • POST https://api.rippling.com/platform/api/ats_candidates/push_candidate

Application Management

  • POST https://api.rippling.com/platform/api/mark_app_installed

Leaves

  • GET https://api.rippling.com/platform/api/leave_requests
  • POST https://api.rippling.com/platform/api/leave_requests
  • GET https://api.rippling.com/platform/api/leave_balances
  • GET https://api.rippling.com/platform/api/leave_balances/{role}
  • POST https://api.rippling.com/platform/api/leave_requests/{id}/process
  • PATCH https://api.rippling.com/platform/api/leave_requests/{id}
  • DELETE https://api.rippling.com/platform/api/leave_requests/{id}

To know more about Rippling API endpoints, click here.

Rippling API use cases

  • Global workforce management with seamless onboarding, global payments in local currencies, and automation of compliance work
  • Policy management to manage all your HR, IT, and Finance policies in one place with automated policy enforcement with reminders, updates
  • Custom workflows to automate your manual HR, IT, and Finance processes with custom triggers and automated actions for emails, messages, etc. 
  • Access and approval management to seamless keep a check on what your employees can see and do in every business system by controlling access, data and approvals
  • Workforce analytics to unify and analyze all your workforce data across every business system with powerful reporting

Top customers

  • Literati, a children's book club and subscription service
  • Morning Consult, a business intelligence company
  • Stacklet, a cloud governance company
  • M9 Solutions, an IT services and solutions company
  • Open Door Legal,  an award-winning nonprofit in legal services

Rippling API FAQs

Check out some of the top Rippling API FAQs to address some of your initial queries:

  1. What apps does Rippling integrate with? Answer
  2. How long does IT take to implement Rippling? Answer
  3. What type of system is Rippling? Answer
  4. Does Rippling require pagination? Answer
  5. How do I build a user management integration with Rippling's API? Answer
  6. Why is there a beta tag attached to my application in the Rippling app shop? Answer
  7. Are there any costs or fees associated with building an API integration with Rippling? Answer
  8. Does Rippling support IDP-initiated OIDC SSO flows? Answer

How to integrate with Rippling API

Here is a quick guide to help you get started with integration for Rippling API. 

Get started with Rippling API

The pricing for Rippling API starts at $8 a month, per user. For more custom pricing based on your requirements, you can request a custom quote. However, you can get started with Knit, one API for all your integrations. Sign up with Knit, starting at $1500 for up to 5 connected customers. Claim your free access here

API Directory
-
Jul 31, 2023

Guide to Integrating With Namely API

Namely is a leading HRMS platform, enabling companies to manage all HR, payroll and benefits related activities together. It ensures that all HR related data is available for companies at one place and offers a personalized experience. Namely API allows users to connect all their employee data for a smooth HR function. 

This guide includes popular Namely API endpoints, use cases, FAQs and links to everything else you will need to start using Namely API today.

The Namely API is a REST-based API with JSON-encoded responses, leveraging standard HTTP response codes, authentication, and verbs. Upon integration with Namely API, users get access to data from the HRMS platform for better workflow management and insights. To maintain high levels of security, Namely API supports two forms of authentication, i.e. the standard 3-legged OAuth 2.0 authorization code grant and Bearer token authentication.

Namely API endpoints

There are several endpoints within Namely API, based on how different fields are grouped for data filtering. 

Groups and Teams endpoints

Defining how profiles of employees are organized within Namely API. The Groups and Teams Endpoints can be found here

Home Feed Endpoints

Categorization of posts on Namely Home Feed across events, announcements, birthdays, anniversaries, new arrival, etc. All Home Feed endpoints are mentioned here

Jobs Information Endpoints

View, create and update all job related information with these API endpoints, including, job, job tiers, job title, etc. To see all Job Information endpoints, click here

Namely Systems Information Endpoints

Defining the valid values and formats for countries and subdivisions for use and reference. All Namely Systems Information Endpoints can be found here

Profile Fields Endpoints

Defining the structure of the profile at any company. These endpoints focus on where fields are on the profile, in what sections they belong, what those different sections are, etc. With this API, you can view, create and update profile fields and profile fields sections. To see all Profile Fields Endpoints, click here

Profiles Endpoints

Focusing on the content of the user’s profile within Namely, as opposed to Profile Fields endpoints, which focus on structure of profile at the company. This API is useful to view, create or update profiles (when onboarding or otherwise). For a detailed view on Profiles Endpoints, check this out. 

Namely API use cases

  • HR software for onboarding & e-verify integration, employee directory & company resources, time off tracking, custom workflows & approvals, etc. 
  • Benefits administration with unified HR & payroll data, open enrollment dashboard, ACA Reporting, etc. 
  • Compliance for unlimited access to expert HR advisors, comprehensive compliance library, anonymous employee reporting solution, law & compliance alerts, 300+ delivered training & compliance courses
  • Talent management with job posting + syndication, applicant tracking, background checks, company social newsfeed, performance review, continuous feedback & appreciations
  • Payroll and time management integrated with HR, benefits & time, employee self service & expense tracking, unlimited on and off cycle payrolls, tax calculation & filing, web punch, online timesheets

Namely API FAQs

Here are a few FAQs which can help you in your Namely API journey.

  1. How to Automate a Report from Namely using API? Answer
  2. What are the endpoints of Namely API? Answer
  3. How to Query/Update a Namely Profile using their API with Python? Answer

How to integrate with Namely API

For a quick guide on integrating with Namely API, click here.

Get started with Namely API

Namely’s pricing is not readily available and users have to get in touch with their team to understand the same.

However, if you are looking to integrate with multiple HRMS APIs in the shortest time, you can get started with Knit, one API for all top HR integrations.

To sign up for free, click here. To check the pricing, see our pricing page