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. 

‍

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. 

‍

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. 

‍

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. 

‍

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. 

‍

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

‍