7Shifts API Directory
Read more
Deel is a cutting-edge software platform designed to streamline payroll, HR management, and Employer of Record (EOR) solutions for businesses looking to expand their global workforce. By enabling companies to hire and pay employees in over 150 countries, Deel addresses the complexities of international compliance, taxes, and local labor laws. This makes it an invaluable tool for organizations aiming to manage their global workforce efficiently and effectively.
One of the standout features of Deel is its robust API integration capabilities, which allow businesses to seamlessly connect Deel's functionalities with their existing systems. The Deel API facilitates smooth data exchange and process automation, enhancing the overall efficiency of global HR operations. As companies increasingly seek to leverage technology for workforce management, understanding the Deel API integration process becomes crucial for optimizing their international hiring strategies.
For quick and seamless access to Deel API, Knit API offers a convenient solution. By integrating with Knit just once, you can integrate with Deel and multiple other HRIS, Payroll, CRM, Accounting and other tools. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. Tthis approach not only saves time but also ensures a smooth and reliable connection to your Deel API.
To sign up for free, click here. To check the pricing, see our pricing page.
Ashby software is a robust recruiting platform designed to transform the way organizations manage their recruitment and talent acquisition processes. By integrating Applicant Tracking System (ATS), analytics, scheduling, Customer Relationship Management (CRM), and sourcing capabilities, Ashby offers a comprehensive solution that empowers recruiting teams to streamline their operations and make data-driven decisions. This all-in-one platform is tailored to enhance efficiency and strategic planning, making it an indispensable tool for modern recruitment teams.
One of the standout features of Ashby is its ability to seamlessly integrate with various systems through the Ashby API. This integration capability allows organizations to connect Ashby with their existing tools and platforms, ensuring a smooth flow of data and enhancing the overall recruitment process. The Ashby API is designed to be user-friendly and flexible, enabling developers to customize and extend the platform's functionalities to meet specific organizational needs. By leveraging the Ashby API, companies can optimize their recruitment strategies and achieve better outcomes.
For quick and seamless access to Ashby API, Knit API offers a convenient solution. By integrating with Knit just once, you can integrate with multiple other ATS, HRIS, Payroll and other systems. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to your Ashby API.
To sign up for free, click here. To check the pricing, see our pricing page.
7Shifts is a robust employee scheduling software tailored specifically for the restaurant industry, offering a suite of tools that streamline workforce management. By focusing on the unique needs of restaurant operations, 7Shifts provides features such as scheduling, time tracking, tip management, payroll integration, and team communication. These functionalities are designed to enhance operational efficiency, reduce labor costs, and improve staff productivity, making it an essential tool for restaurant managers looking to optimize their workforce management processes.
One of the standout features of 7Shifts is its ability to integrate seamlessly with various platforms through the 7Shifts API. This integration capability allows restaurants to connect their existing systems with 7Shifts, ensuring a smooth flow of data and enhancing overall operational efficiency. The 7Shifts API enables businesses to customize their scheduling and workforce management processes, providing a flexible solution that adapts to the specific needs of each restaurant. As such, understanding the 7Shifts API integration process is crucial for maximizing the software's potential and achieving optimal results in restaurant management.
POST https://api.7shifts.com/oauth2/token : This API endpoint is used to acquire an OAuth token from the 7shifts API. It requires a POST request to the URL 'https://api.7shifts.com/oauth2/token' with headers specifying 'Content-Type' as 'application/x-www-form-urlencoded' and 'accept' as 'application/json'. The request body must include 'grant_type', 'client_id', 'client_secret', and 'scope'. The 'grant_type' should be 'client_credentials' for Partner OAuth tokens. The response includes a 'token_type' which is 'Bearer', 'expires_in' indicating the number of seconds until the token expires, and an 'access_token' which is the authorization token. Optionally, a 'refresh_token' may also be provided.
GET https://api.7shifts.com/v2/companies/{id} : The Get Company Details API retrieves detailed information about a specific company using its ID. The request requires the company ID as a path parameter and optionally accepts headers for API version and company GUID. The response includes company details such as name, country, plan ID, status, and metadata. The response status can be active, trial, cancelled, delinquent, expired, or unknown.
POST https://api.7shifts.com/v2/partner_company_creation : The Create Trial Company API endpoint allows partners with OAuth clients to create a trial company with The Works plan, a single location, and one administrator. The administrator will receive an invitation email from 7shifts to complete the company setup. The request requires a JSON body with fields such as email, firstname, lastname, company_name, country, and utm_source. Optional fields include mobile_phone, utm_campaign, utm_content, utm_medium, and utm_term. The response includes a 201 status code with company, location, and user IDs if successful, or various error codes and messages if the request fails.
GET https://api.7shifts.com/v2/company/{company_id}/locations : The Get Company Locations API retrieves a list of locations for a specified company. The request requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Query parameters such as modified_since, deleted, cursor, and limit can be used to filter and paginate the results. The response includes an array of location objects, each containing details such as id, name, country, state, city, formatted address, latitude, longitude, timezone, and operational hours. The meta object provides pagination information with cursor details.
DELETE https://api.7shifts.com/v2/company/{company_id}/locations/{location_id} : This API endpoint allows the deletion of a specific location from a company in the 7shifts system. It requires the company ID and location ID as path parameters. The request must include the 'accept' header with the value 'application/problem+json'. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The API returns a 204 status code for successful deletion, and error responses with detailed problem descriptions for 403 (Forbidden), 404 (Not Found), and 500 (Server Error) status codes.
GET https://api.7shifts.com/api/v2/company/{company_id}/location/{location_id}/daily_stats : This API endpoint retrieves daily statistics for a specific company location. It requires the company_id and location_id as path parameters. The API supports optional headers for specifying the API version and company GUID. The query parameters include department_id (optional), date (required), and include_future (optional). The response includes detailed sales and labor statistics, both current and past, in cents, along with labor ratios and sales per man hour. The response is structured with a summary and intervals of data, providing a comprehensive view of daily statistics.
GET https://api.7shifts.com/v2/company/{company_id}/departments : The Get Company Departments API retrieves a list of departments for a specified company. The request requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Optional query parameters include modified_since to filter departments modified after a certain date, cursor for pagination, limit to specify the number of results per page, and location_id to filter departments by location. The response includes a list of department objects with details such as id, company_id, location_id, name, default status, and timestamps for creation and modification. The meta object contains pagination information.
PUT https://api.7shifts.com/v2/company/{company_id}/departments/{department_id} : The Update Department Details API allows users to update the details of a specific department within a company. The API requires the company_id and department_id as path parameters. The request headers can include optional parameters such as x-api-version and x-company-guid. The request body must include the department name and a boolean indicating if the department is the default for the location. The API returns a 200 OK response with the updated department details if successful. Error responses include 403 Forbidden, 404 Not Found, and 500 Server Error, each providing details about the error.
POST https://api.7shifts.com/v2/company/{company_id}/users : This API endpoint allows the creation of a new user within a specified company on the 7shifts platform. The request requires the company ID as a path parameter and includes various user details in the request body, such as first name, last name, location IDs, department IDs, and user type. Optional fields include email, phone numbers, address, and more. The response returns the created user's details, including their ID, name, contact information, and status. The API supports different user types like employee, assistant manager, and manager, and allows setting roles, wages, and permissions for the user.
DELETE https://api.7shifts.com/v2/company/{company_id}/users/{identifier} : The Delete User from Company API allows you to remove a user from a specified company in the 7shifts system. This API requires the company ID and user ID as path parameters. Optional headers include the API version and company GUID. The Authorization header with a Bearer token is required. The request body must include an inactive reason and can optionally include comments related to the user deletion. The API returns a 204 No Content response on success. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Server Error, each providing detailed error information.
POST https://api.7shifts.com/v2/company/{company_id}/shifts : This API endpoint allows the creation of a shift for a specified company using the 7shifts platform. The endpoint requires a POST request to the URL https://api.7shifts.com/v2/company/{company_id}/shifts, where {company_id} is a path parameter representing the unique identifier of the company. The request headers may include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body must include 'location_id', 'start', and 'end' as required fields, along with optional fields such as 'user_id', 'department_id', 'role_id', and others to define the shift details. The response returns a JSON object containing the shift details, including 'id', 'user_id', 'start', 'end', and other attributes. The API also handles error responses for bad requests, forbidden access, and unprocessable entities.
GET https://api.7shifts.com/v2/company/{company_id}/shifts/{shift_id} : The Get Shift Details API retrieves detailed information about a specific shift for a given company. It requires the company_id and shift_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. An optional query parameter include_deleted can be used to include deleted shifts in the response. The response includes detailed shift information such as start and end times, user and location IDs, wage, notes, and more. The response also includes information about breaks associated with the shift.
GET https://api.7shifts.com/v2/time_off : The Get Time Off Details API endpoint allows users to retrieve time off details for a specified company. The API requires the 'company_id' as a mandatory query parameter. Optional query parameters include 'location_id', 'user_id', 'status', 'category', 'to_date_gte', 'sort_by', 'sort_dir', 'cursor', and 'limit'. The API also accepts optional headers 'x-api-version' and 'x-company-guid', and requires an 'Authorization' header with a Bearer token. The response includes an array of time off details with fields such as 'id', 'user_id', 'company_id', 'from_date', 'to_date', 'partial', 'comments', 'status', 'category', 'created', 'amount_of_hours', and 'hours'. The response also contains metadata for pagination.
PATCH https://api.7shifts.com/v2/time_off/{time_off_id} : The Update Time Off Request API allows users to modify an existing time off request by providing the time_off_id in the path. The request requires headers such as 'accept' and 'content-type' set to 'application/json', and an 'Authorization' header with a Bearer token. Optional headers include 'x-api-version' for specifying the API version and 'x-company-guid' for the company GUID. The request body must include details such as user_id, from_date, to_date, partial, comments, status, category, and hours. The response returns the updated time off details including id, user_id, company_id, from_date, to_date, partial, comments, status, category, created date, and amount of hours. In case of an error, a detailed error message is provided.
GET https://api.7shifts.com/v2/reports/daily_sales_and_labor : The Get Daily Sales and Labor Report API provides detailed daily sales and labor data for a specified date range and location. It requires the 'start_date', 'end_date', and 'location_id' as query parameters, with optional 'department_id'. The API returns a list of daily reports, each containing information such as actual and projected sales, labor costs, items sold, and labor hours. The response includes detailed metrics like sales per labor hour and labor percent, allowing businesses to analyze their performance effectively.
GET https://api.7shifts.com/v2/reports/hours_and_wages : The Get Hours and Wages Report API endpoint retrieves detailed reports on hours worked and wages earned by employees within a specified date range. The API requires a minimum plan of 'The Works' and may experience performance limitations, potentially resulting in 500 errors due to timeouts. It is recommended to include a location_id to minimize the number of locations in the report and to shorten the report period to a single week if errors persist. The API accepts headers for API version and company GUID, and query parameters including punches, company_id, from and to dates, and optional location_id, department_id, role_id, and user_id. The response includes detailed employee data, shifts, roles, and total hours and pay information, with options to show exception costs and tips.
GET https://api.7shifts.com/v2/company/{company_id}/webhooks : The Get Company Webhooks API retrieves a list of webhooks for a specified company. It requires the company_id as a path parameter. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. Optional query parameters include modified_since to filter webhooks modified after a certain date, cursor for pagination, and limit to specify the number of results per page. The response includes a list of webhooks with details such as id, company_id, url, method, event, created, and modified timestamps, along with pagination metadata.
DELETE https://api.7shifts.com/v2/company/{company_id}/webhooks/{webhook_id} : This API endpoint allows the deletion of a specific webhook for a company using the DELETE method. The request requires the company_id and webhook_id as path parameters. Optional headers include x-api-version for specifying the API version and x-company-guid for the company GUID. The response will be a 204 No Content on success, or an error object with details in case of failure, such as 401 Unauthorized, 403 Forbidden, 404 Not Found, or 500 Server Error.
For quick and seamless access to 7Shifts API, Knit API offers a convenient solution. By integrating with Knit just once, you can integrate with 7Shifts and multiple other HR & Payroll Systems. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to your 7Shifts API.
To sign up for free, click here. To check the pricing, see our pricing page.
Lever is a talent acquisition platform that helps companies simplify and improve their hiring process. With tools for tracking applicants and managing relationships, Lever makes it easy for teams to attract, engage, and hire the best talent. Its user-friendly design and smart features help companies of all sizes make better hiring decisions while improving the candidate experience.
Lever also offers APIs that allow businesses to integrate the platform with their existing systems. These APIs automate tasks like syncing candidate data and managing job postings, making the hiring process more efficient and customizable.
Key highlights of Lever APIs are as follows:
This article will provide an overview of the Lever API endpoints. These endpoints enable businesses to build custom solutions, automate workflows, and streamline HR operations.
Here are the most commonly used API endpoints in the latest version -
Applications
Archive Reasons
Audit Events
Contacts
EEO (Equal Employment Opportunity Questions)
Feedback
Feedback Template
Files
Interviews
Note
Offers
Opportunity
Panels
Posting
Profile Form
Requisition
Requisition Fields
Resume
Sources
Stage
Surveys
Tags
Upload
Users
Here’s a detailed reference to all the Lever API Endpoints.
Here are the frequently asked questions about Lever APIs to help you get started:
Find more FAQs here.
Lever API access is only available for integration after a careful internal review based on your interest. However, if you want to integrate with multiple HRMS or Recruitment APIs quickly, 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.
Paycom is a comprehensive cloud-based HR and payroll software provider that helps businesses manage their workforce with ease. Founded in 1998, it offers an all-in-one solution that integrates various HR functions, including payroll processing, time and attendance tracking, talent management, and benefits administration.
Paycom’s platform streamlines HR tasks by providing real-time data and automating workflows, allowing companies to reduce manual errors and increase efficiency. Its user-friendly interface empowers employees to access and manage their personal information, making it a valuable tool for both HR teams and employees alike.
Paycom also offers a suite of APIs for integrating various HR and payroll functionalities into applications. Key highlights include:
Paycom offers several commonly used API endpoints that cover various aspects of HR, payroll, and employee management.
Here are some of the key endpoints you might use:
Here are the frequently asked questions about Paycom APIs to help you get started:
1. Does Paycom provide public APIs for direct integration?
2. What type of data can I retrieve through Paycom integrations?
3. Is custom API development required to integrate Paycom with my systems?
4. What security measures are in place for Paycom integrations?
5. Can I automate employee onboarding and payroll using Paycom integrations?
Paycom doesn’t provide public APIs for direct integration. Instead, companies can use third-party services like Knit, which offers ready-made integrations with Paycom. Knit helps you connect to Paycom’s systems to get important data like employee records, payroll details, and time tracking.
By using Knit’s unified APIs, you can standardize data and simplify processes across different HR systems, including Paycom. This makes it easier to automate HR tasks and connect Paycom with other tools without needing custom API development.
To sign up for free, click here. To check the pricing, see our pricing page.
UKG Pro is a human capital management (HCM) solution that simplifies payroll, HR, talent management, and employee engagement. With an easy-to-use interface, it helps businesses manage their workforce efficiently and boost productivity.
UKG Pro APIs allow developers to integrate its HR, payroll, and management features into custom applications. These APIs provide access to employee data, payroll, and more, enabling businesses to build tailored solutions, improve workflows, and create a connected HR system.
Key highlights of UKG Pro APIs are as follows -
This article will provide an overview of the UKG Pro API endpoints. These endpoints enable businesses to build custom solutions, automate workflows, and streamline HR operations.
Here are the most commonly used API endpoints in the latest version -
Company Details
Compensation Details
Employee Deductions
Employee Change
Employee Contact Details
Employee Contract Details
Employee Demographic Details
Employee Education Details
Employee Employment Details
Employee Job History Details
Employee ID Lookup
Employee Pay Statement
Employment Details
Jobs Configuration
Person Details
PTO Plans
Recruiting
User Details
Here’s a detailed reference to all the UKG Pro API Endpoints.
Here are the frequently asked questions about UKG Pro APIs to help you get started:
Find more FAQs here.
UKG Pro API access is only available by contacting their support or account management team. However, if you want to integrate with multiple HRMS or Recruitment APIs quickly, you can get started with Knit, one API for all top integrations.
To sign up for free, click here. To check the pricing, see our pricing page.
Paychex is a payroll and HR solutions provider designed to simplify workforce management for businesses of all sizes. It offers a range of tools for payroll processing, employee benefits, time tracking, and compliance, helping companies streamline their HR tasks.
With Paychex’s API, developers can integrate payroll, benefits, and other HR data with external applications, enabling automation and creating a seamless experience for managing employee-related tasks across platforms.
Here are some key highlights of the Paychex APIs:
In this article, we will explore what are the most commonly used Paychex API endpoints and how they allow businesses to streamline their HR and payroll operations, making it easy to integrate Paychex services into existing workflows.
Here are the most commonly used Paychex API endpoints -
Authentication
Company
Payroll
Worker
Management
Webhooks
Here’s a detailed reference to all the Paychex API Endpoints.
Here are the frequently asked questions about Paychex APIs to help you get started:
Find more FAQs here.
To access Paychex APIs, create a Paychex account and log in to the Developer Portal. Apply for API access, and upon approval, you'll receive your API credentials (client ID and secret). Use these for OAuth 2.0 authentication to securely access the API endpoints. Review the documentation for integration guidelines.
If you’re looking for a quick way to connect multiple Payroll systems, consider using Knit—a single API solution that integrates with major platforms, streamlining your setup and reducing development time. To sign up for free, click here. To check the pricing, see our pricing page.
Sage Intacct is a cloud-based accounting system designed to help businesses manage their finances more efficiently. It automates essential tasks, provides real-time financial insights, and scales with business growth.
In addition to its core features, Sage Intacct offers powerful APIs that allow seamless integration with other tools and customizable workflows. These APIs enable businesses to automate invoicing, reporting, and payment processing, further enhancing operational efficiency.
Key highlights of Sage Intacct APIs are as follows:
In this article, we’ll explore how Sage Intacct’s APIs can streamline your financial operations, enhance flexibility, and highlight the most commonly used endpoints.
Sage Intacct primarily uses a SOAP API for its integrations. The API follows the SOAP protocol and relies on XML for request and response formats, which provides structured and standardized communication. While this means it’s a bit more complex to implement compared to REST APIs, it’s highly secure and reliable, making it well-suited for handling sensitive financial data.
Here are the commonly used Sage Intacct API endpoints, categorized by function:
These additional endpoints provide extensive support for more complex financial, HR, tax, and asset management tasks, allowing businesses to integrate Sage Intacct across diverse operations.
Here’s a detailed reference to all the Sage Intacct API Endpoints.
Here are the frequently asked questions about Sage Intacct APIs to help you get started:
Find more FAQs here.
Sage Intacct API access is available for integration after a thorough internal review to ensure alignment with your business needs. However, if you’re looking to quickly connect with multiple HR, Accounting, CRM, and more integrations consider using Knit—a single API solution that integrates with all major HR platforms, simplifying your setup process.
To sign up for free, click here. To check the pricing, see our pricing page.
Adobe Sign, introduced in 2006 as part of Adobe's comprehensive suite of document management solutions, has transformed the way businesses handle electronic signatures and document workflows.
With Adobe Sign APIs, developers can access powerful tools that enable seamless integration of e-signature capabilities into their applications, providing a secure and efficient way to manage digital transactions.
Key highlights of Adobe Sign APIs are as follows:
In this article, we'll provide an overview of the Adobe Sign API endpoints.
While there are several Adobe Sign API endpoints, here are the most commonly used ones in the latest version:
Transient Documents
These endpoints are used to upload a document, get its document ID, and get the requested views for that document.
Agreements
These are used to create, send, and manage agreements and documents for e-signature.
Users
These are used to manage user accounts, permissions, and roles within the Adobe Sign system.
Library Documents
These help to create and manage template documents that can be reused for multiple agreements.
Search
This API helps to retrieve, search, filter, and sort agreements for the user.
Workflows
These APIs help to automate and manage multi-step signing processes and workflows.
MessageTemplates
These APIs help to retrieve a list of message templates applicable to the current user.
MegaSigns
These APIs help to send a single document to multiple recipients for individual signatures.
Webhooks
These APIs help to create and manage webhooks.
Here’s a detailed reference to all the Adobe Sign APIs.
Here are the frequently asked questions about Adobe Sign APIs to help you get started:
Adobe Sign API access is reserved exclusively for enterprise and developer tier accounts. However, if you want to integrate with multiple HRMS or Recruitment APIs quickly, 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.
Find more FAQs here.
Zoho Desk is a powerful, cloud-based customer service software designed to streamline support operations and enhance customer satisfaction. As part of the Zoho suite, Zoho Desk empowers businesses to manage customer queries across multiple channels—email, social media, chat, and more—through a unified platform. It offers features like ticket management, workflow automation, and detailed analytics, helping support teams stay organized and efficient.
With the Zoho Desk API, developers can take things a step further by connecting Zoho Desk with other tools, automating tasks, and customizing workflows.
Key highlights of Zoho Desk API are as follows -
In this article, we’ll explore the key Zoho Desk API endpoints and how they can provide flexibility to build powerful, custom solutions that enhance your customer service capabilities.
Zoho Desk APIs make it easy to connect with other Zoho apps and external tools by using RESTful principles. With these APIs, you can automatically get and update data in various parts of Zoho Desk, like Tickets, Contacts, and Accounts. All the APIs follow standard HTTP rules and use error codes for better understanding.
Here are the most commonly used Zoho Desk API endpoints -
Organizations
Agents
Profiles
Roles
Teams
Departments
Channels
Tickets
Thread
Contacts
Accounts
Account Contact Mapping
Tasks
Products
Users
Contracts
Upload
Activities
Calls
Events
Skills
Subscriptions
Time Entries
Here’s a detailed reference to all the Zoho Desk API Endpoints.
Here are the frequently asked questions about Zoho Desk APIs to help you get started:
Find more FAQs here.
To access the Zoho Desk API, you'll need a Zoho account and an API key, which you can obtain from the Zoho Developer Console. After logging into your Zoho account, navigate to the API Console to create a new client and get your client ID and client secret. Zoho Desk uses OAuth 2.0 for secure authentication, so you’ll authorize the app to generate access tokens. Once authenticated, you’ll have access to Zoho Desk’s API endpoints to start building and integrating with your applications.
If you’re looking for a quick way to connect multiple customer service or CRM systems, consider using Knit—a single API solution that integrates with major platforms, streamlining your setup and reducing development time. To sign up for free, click here. To check the pricing, see our pricing page.
QuickBooks is an easy-to-use accounting software that helps small and medium-sized businesses manage their finances. It offers tools for invoicing, tracking expenses, handling payroll, and preparing taxes, all in one place.
With QuickBooks Online APIs, whether you’re launching a new business or have been running one for years, managing your finances becomes easier and more efficient.
Key highlights of QuickBooks Online APIs:
While we have covered the Quickbooks Online API in depth earlier, in this article, we'll provide an overview of the QuickBooks Online API endpoints.
While there are several QuickBooks Online API endpoints, here are the most commonly used ones:
These endpoints offer more granular control and functionality, allowing developers to build more customized and detailed integrations with QuickBooks.
Here’s a detailed reference to all the QuickBooks Online APIs.
Here are the frequently asked questions about QuickBooks Online APIs to help you get started:
QuickBooks Online API access is available only for enterprise and developer tier accounts. If you're looking to integrate with various HRMS or recruitment APIs easily, consider using Knit. Knit offers a single API for connecting with all major HR integrations.
To sign up for free, click here. To check the pricing, see our pricing page.
Dropbox Sign, formerly HelloSign, is an electronic signature platform allowing users to securely sign, send, and manage legally binding documents online. It can be integrated seamlessly with Dropbox and other cloud services, and simplifies workflows by enabling remote collaboration and reducing the need for physical paperwork. Ideal for businesses of all sizes, Dropbox Sign ensures compliance with global e-signature laws, offering a fast and reliable contract management and document processing solution.
Dropbox Sign APIs enable developers to integrate electronic signature functionality directly into their applications. With easy-to-use endpoints, the API allows businesses to automate document workflows, request signatures, and track the status of agreements in real-time. It supports advanced features like template creation, embedded signing, and customizable branding, making it flexible for many use cases. The API also ensures security and compliance, providing audit trails and adhering to global e-signature standards like ESIGN and eIDAS.
Key highlights of Dropbox Sign APIs include:
In this article, we’ll provide an overview of the Dropbox Sign API endpoints.
Here are the most commonly used Dropbox API endpoints:
Account
Signature Request
Templates
Bulk Send Job
Report
Team
Unclaimed Draft
Embedded
Here’s a detailed reference to all the Dropbox API endpoints.
Here are the frequently asked questions about Dropbox Sign APIs to help you get started:
Find more FAQs here.
Dropbox Sign API access is offered through various pricing plans: Essentials, Standard, and Premium. It also includes a test mode for trying out features before deploying them in production. For quick integration with multiple eSignature APIs, you can use Knit, a single API that connects to top SaaS platforms.
To sign up for free, click here. To check the pricing, see our pricing page.
PandaDoc is a simple platform for creating, sending, and signing documents like contracts and quotes. It helps businesses reduce paperwork, save time, and work more smoothly with templates and eSignatures.
PandaDoc also provides APIs that let companies integrate its features into their own apps, automating document creation, managing templates, and handling eSignatures easily. This is especially useful for businesses that need to scale or customize their document processes. In this article, we will provide an overview of the Pandadoc API endpoints.
Key features of PandaDoc APIs include:
These features allow businesses to automate and streamline their document processes effectively.
Here are the most commonly used Pandadoc API endpoints -
Here’s a detailed reference to all the Pandadoc APIs.
Here are the frequently asked questions about Pandadoc APIs to help you get started:
Find more FAQs here.
Pandadoc API is available for free testing in a sandbox environment and later has to be upgraded to an enterprise account for use in production. However, if you want to integrate with multiple e-signature APIs quickly, you can get started with Knit, one API for all top integrations.
To sign up for free, click here. To check the pricing, see our pricing page.
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.
While there are several Workday API endpoints, some of the top ones include:
Here’s a detailed guide on all Workday API endpoints as a ready reference.
Check out the top FAQs for Workday API to help you get started
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
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
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 (ADP Workforce Now) uses the following endpoints to facilitate the flow of information and data across channels.
Worker: A person who works/ performs duties for an organization
Worker Images
Worker Profile Photo Management
Workers Data Retrieval
Worker.hire: Primary work assignment created between a worker/ person and the employer for the first time.
Rehire Worker
Read Worker
Worker Demographics: Demographics and information for all workers as well as each worker specifically.
Worker Demographics
Worker associate profile: Extensions to the worker profile containing hobbies/interests, bio, Standout roles, etc.
Associate Preferred Gender Pronoun
Add Additional Remuneration
Change Additional Remuneration
Change Base Remuneration
Remove Additional Remuneration
Work assignment: Details such as a worker's Job Title and Job Function.
Modify Assigned Organizational Units
Modify Work Assignment
Modify Worker Reports
Terminate Work Assignment
Personal connects: To retrieve, add, update, and delete an associate's emergency contacts.
Add Personal Contact
Change Personal Contact
Personal Contacts
Remove Personal Contact
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
Corporate Groups Management
Position Data Management
Add Worker Business Email
Add Worker Business Fax
Add Worker Business Landline
Add Worker Business Mobile
Add Worker Business Pager
Change Worker Business Email
Change Worker Business Fax
Change Worker Business Landline
Change Worker Business Mobile
Change Worker Business Pager
Remove Worker Business Email
Remove Worker Business Fax
Remove Worker Business Landline
Remove Worker Business Mobile
Remove Worker Business Pager
Corporate directory: List of corporate contacts or detailed information about a specific contact
Corporate Directory
Add Work Assignment
Change Birth Date
Change Gender
Change Race
Change Worker Gender Identity
Change Birth Name
Change Legal Name
Change Preferred Name
Change Worker Marital Status
Change Worker Military Classification
Change Worker Military Status
Add Worker Legal Address
Add Worker Personal Address
Add Worker Personal Email
Add Worker Personal Fax
Add Worker Personal Landline
Add Worker Personal Mobile
Add Worker Personal Pager
Change Worker Legal Address
Change Worker Personal Address
Change Worker Personal Email
Change Worker Personal Fax
Change Worker Personal Landline
Change Worker Personal Mobile
Change Worker Personal Pager
Remove Worker Legal Address
Remove Worker Personal Address
Remove Worker Personal Email
Remove Worker Personal Fax
Remove Worker Personal Landline
Remove Worker Personal Mobile
Remove Worker Personal Pager
Change Standard Hours
Change Worker Type
Change Worker Custom Percentage
Change Worker Custom Telephone
Manage Worker Custom Amount
Manage Worker Custom Code
Manage Worker Custom Date
Manage Worker Custom Indicator
Manage Worker Custom Number
Manage Worker Custom String
Add Worker Government ID
Change Worker Government ID
Change Person Custom Amount
Change Person Custom Code
Change Person Custom Date
Change Person Custom Indicator
Change Person Custom Number
Change Person Custom Percentage
Change Person Custom String
Change Person Custom Telephone
Worker leaves: Processing an employee's leave requests, changes, and return and leave cancellations.
Cancel Worker Leave
Change Worker Leave
Request Leave Of Absence
Request Return From Leave Of Absence
Worker Leaves
Change Worker Highest Education Level
Here is a comprehensive list of questions that can help you navigate ADP API for success:
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:
Here is a comprehensive resource for anyone who wishes to integrate with ADP API and streamline and optimize their HR and allied operations.
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
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 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.
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.
greytHR provides HRMS services to 20,000+ companies across 250+ cities, including:
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.
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!
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.
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.
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.
https://people.zoho.com/people/api/forms/<inputType>/<formLinkName>/insertRecord?inputData=<inputData>
https://people.zoho.com/people/api/forms/json/employee/insertRecord?inputData=<inputData>
https://people.zoho.com/people/api/forms/<inputType>/<formLinkName>/updateRecord?inputData=<inputData>&recordId=<recordId>
https://people.zoho.com/people/api/forms/<formLinkName>/getRecords?sIndex=<record starting index>&limit=<maximum record to fetch>
https://people.zoho.com/people/api/department/records?xmlData=<xmlData>
https://people.zoho.com/people/api/forms?
https://people.zoho.com/people/api/forms/<formLinkName>/getDataByID?recordId=261091000000049003
https://people.zoho.com/people/api/forms/<formLinkName>/getRecordByID?recordId=<recordId>
https://people.zoho.com/people/api/forms/<formLinkName>/getRelatedRecords?sIndex=<sIndex>&limit=<limit>& parentModule=<parentModule>&id=<id>&lookupfieldName=<lookupfieldName>
https://people.zoho.com/people/api/forms/<formLinkName>/getRecords?searchParams={searchField: '<fieldLabelName>', searchOperator: '<operator>', searchText : '<textValue>'}
https://people.zoho.com/people/api/forms/<formLinkName>/components?
https://people.zoho.com/api/hrcases/addcase?categoryId=<Category ID>&subject=<subject>&description=<description>
https://people.zoho.com/api/hrcases/viewcase?recordId=<Reord ID of the case>
https://people.zoho.com/api/hrcases/getRequestedCases?index=<index>&status=<status>
https://people.zoho.com/api/hrcases/listCategory?
https://people.zoho.com/people/api/timetracker/createtimesheet?user=<user>×heetName=<timesheetName>&description=<description>&dateFormat=<dateFormat>&fromDate=<fromDate>&toDate=<toDate>&billableStatus=<billableStatus>&jobId=<jobId>&projectId=<projectId>&clientId=<clientId>&sendforApproval=<sendforApproval>
https://people.zoho.com/people/api/timetracker/modifytimesheet?timesheetId=<timesheetId>×heetName=<timesheetName>&description=<description>&sendforApproval=<sendforApproval>&removeAttachment=<removeAttachment>
https://people.zoho.com/people/api/timetracker/gettimesheet?user=<user>&approvalStatus=<approvalStatus>&employeeStatus=<employeeStatus>&dateFormat=<dateFormat>&fromDate=<fromDate>&toDate=<toDate>&sIndex=<sIndex>&limit=<limit>
https://people.zoho.com/people/api/timetracker/gettimesheetdetails?timesheetId=<timesheetId>&dateFormat=<dateFormat>
https://people.zoho.com/people/api/timetracker/approvetimesheet?authtoken=<authtoken>×heetId=<timesheetId>&approvalStatus=<approvalStatus>&timeLogs=<timeLogs>&comments=<comments>&isAllLevelApprove=<isAllLevelApprove>
https://people.zoho.com/people/api/timetracker/deletetimesheet?timesheetId=<timesheetId>
https://people.zoho.com/api/<Employee|Candidate>/triggerOnboarding
https://people.zoho.in/people/api/forms/json/Candidate/insertRecord?inputData=<inputData>
https://people.zoho.com/people/api/forms/<inputType>/Candidate/updateRecord?inputData=<inputData>&recordId=<recordId>
https://people.zoho.com/people/api/forms/<inputType>/<formLinkName>/insertRecord?inputData=<inputData>
https://people.zoho.com/people/api/forms/leave/getDataByID?recordId=413124000068132003
https://people.zoho.com/api/v2/leavetracker/leaves/records/cancel/<record-id>
https://people.zoho.com/people/api/v2/leavetracker/reports/user
https://people.zoho.com/people/api/v2/leavetracker/reports/bookedAndBalance
https://people.zoho.com/people/api/v2/leavetracker/reports/bradford
https://people.zoho.com/people/api/v2/leavetracker/reports/encashment
https://people.zoho.com/people/api/v2/leavetracker/reports/lop
https://people.zoho.com/api/leave/addBalance?balanceData=<balanceData>&dateFormat=<dateFormat>
https://people.zoho.com/people/api/attendance/bulkImport?data=<JSONArray>
https://people.zoho.com/api/attendance/fetchLatestAttEntries?duration=5&dateTimeFormat=dd-MM-yyyy HH:mm:ss
https://people.zoho.com/people/api/attendance?dateFormat=<dateFormat>&checkIn=<checkin time>&checkOut=<checkout time>&empId=<employeeId>&emailId=<emailId>&mapId=<mapId>
https://people.zoho.com/people/api/attendance/getAttendanceEntries?date=<date>&dateFormat=<dateformat>&erecno=<erecno>&mapId=<mapId>&emailId=<emailId>&empId=<empId>
https://people.zoho.com/people/api/attendance/getUserReport?sdate=<sdate>&edate=<edate>&empId=<employeeId>&emailId=<emailId>&mapId=<mapId>&dateFormat=<dateFormat>
https://people.zoho.com/people/api/attendance/updateUserShift?dateFormat=<dateformat>&empId=<employee Id>&shiftName=<shift name>&fdate=<FromDate>&tdate=<toDate>
https://people.zoho.com/people/api/attendance/getShiftConfiguration?empId=<employee Id>&emailId<email Id>=&mapId<Mapper ID>=&sdate<startDate>=&edate=<endDate>
https://people.zoho.com/people/api/attendance/getRegularizationRecords
For more information and details on other endpoints, check out this detailed resource.
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.
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.
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 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.
When working with Ceridian Dayforce API, you need to understand the data models, objects and endpoints. Here is a quick overview to get started:
This object represents a dependent of an employee, including child, spouse, partner, etc. It contains data fields like first/last name, relationship, date of birth, gender, if the dependent is a student
This object covers all details relating to an individual or candidate who has been employed by the organization. It contains information or data fields like employee number, first/last name, preferred name, work email, personal email, groups, phone number, home/ work location, employments, manager, team, gender, marital status, employment status, start date, termination date, etc.
This object represents a job position at any company. It contains data fields like employee, job title, pay rate, pay period, pay currency, effective date, employment type, pay frequency, etc.
A group is a subset in which an employee can be placed. Groups can be of multiple types, including teams, pay groups. At the same time, each employee can be a part of multiple groups. It contains data fields or information along the lines of name, type, etc.
This object represents the geographical area which can be associated with an employee. The location object contains data fields including name, street number, city, zip code, country, location type, state, etc.
Team as an object is a subgroup of a company like a department. Each employee is allocated to a particular team as a part of their employment.
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.
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.
With this endpoint, you can get access to information about the dependents, including their name, date of birth, relationship, etc.
This endpoint can be used to get any information needed about the employee, including employment, time off, time off balance, etc.
This endpoint helps get access to information about time off including start time, end time, request type, etc.
With this end point, users can get access to information about an employee’s work assignment focusing on location, zip code, country, among others.
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...
With this endpoint, one can get information about a particular employee, including personal email, home location, ethnicity, employment status, etc.
This endpoint is used to gain access to information about an employee’s team and groups the employee is a part of.
With this endpoint, users get access to information about the time off balance and policy type for each employee.
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:
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.
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.
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 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.
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.
POST/hcmRestApi/resources/11.13.18.05/absences
DELETE/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}
POST/hcmRestApi/resources/11.13.18.05/absences/action/loadProjectedBalance
POST/hcmRestApi/resources/11.13.18.05/absences/action/absenceDailyDetailsBreakdown
GET/hcmRestApi/resources/11.13.18.05/absences
GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}
POST/hcmRestApi/resources/11.13.18.05/absences/action/getAbsenceTypeBalance
POST/hcmRestApi/resources/11.13.18.05/absences/action/findByAdvancedSearchQuery
PATCH/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}
POST/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments
DELETE/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments
GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
PATCH/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements
GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements/{absenceEntitlementsUniqID}
POST/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails
DELETE/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails/{PersonAbsenceEntryDetailId}
GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails
GET/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails/{PersonAbsenceEntryDetailId}
PATCH/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails/{PersonAbsenceEntryDetailId}
GET/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions
POST/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions
DELETE/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}
GET/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}
PATCH/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}
POST/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions
GET/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions
GET/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}
POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/action/allocateChecklist
POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/allocateNewTask
POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/allocateTaskFromTaskLibrary
DELETE/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/forceCloseChecklist
GET/hcmRestApi/resources/11.13.18.05/allocatedChecklists
GET/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
PATCH/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
DELETE/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
GET/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks
GET/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/action/reopenTask
PATCH/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
POST/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/action/updateTaskStatus
POST/hcmRestApi/resources/11.13.18.05/availabilityPatterns
DELETE/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}
GET/hcmRestApi/resources/11.13.18.05/availabilityPatterns
GET/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}
PATCH/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}
GET/hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities
GET/hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities/{PersonNumber}
Check out this detailed guide for all endpoints and data models
12,000+ companies use Oracle Fusion Cloud HCM as their preferred HR tool, including:
To better prepare for your integration journey with Oracle Fusion Cloud HCM API, here is a list of FAQs you should go through:
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.
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
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.
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:
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.
Common attributes: id, created at, updated at, workstation number, date of birth, gender, address, communication address, designation, phone number, joining date, termination date, first name, last name, status, official email, personal email, employee type, team id, department id, reporting to id, time off, hire reason, marital status, etc.
(Used to configure different geographical locations for an organization and associate employees to a branch)
Common attributes: id, created at, updated at, name, street, state, country code, zip, time zone, currency, language, main office, date format
Common attributes: id, created at, updated at, name, description
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
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
Common attributes: id, created at, updated at, deleted, label, default, leads count
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
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:
Here is a list of Freshteam API FAQs that developers must understand to make their integration journey more effective and robust:
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:
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.
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.
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.
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.
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.
GET https://api.zenefits.com/platform/applications
GET https://api.zenefits.com/core/companies
Fields include: ‘legal_name', 'ein','departments', 'locations'
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'
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'
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)
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)
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)
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:
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:
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:
Here is a list of FAQs about TriNet Zenefits API which can help commence and accelerate your integration:
Several businesses are increasingly building integrations with Zenefits API to power operations for the end customers, facilitated by seamless data exchange, including:
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.
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.
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.
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.
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:
POST https://api.gusto-demo.com/v1/provision
GET https://api.gusto-demo.com/v1/companies/{company_id}
GET https://api.gusto-demo.com/v1/companies/{company_id}/custom_fields
POST https://api.gusto-demo.com/v1/companies/{company_id}/locations
GET https://api.gusto-demo.com/v1/companies/{company_id}/locations
GET https://api.gusto-demo.com/v1/locations/{location_id}
PUT https://api.gusto-demo.com/v1/locations/{location_id}
GET https://api.gusto-demo.com/v1/locations/{location_uuid}/minimum_wages
GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules
GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules/{pay_schedule_id}
GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_periods
GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules/assignments
POST https://api.gusto-demo.com/v1/companies/{company_uuid}/departments
GET https://api.gusto-demo.com/v1/companies/{company_uuid}/departments
GET https://api.gusto-demo.com/v1/departments/{department_uuid}
PUT https://api.gusto-demo.com/v1/departments/{department_uuid}
DELETE https://api.gusto-demo.com/v1/departments/{department_uuid}
PUT https://api.gusto-demo.com/v1/departments/{department_uuid}/add
PUT https://api.gusto-demo.com/v1/departments/{department_uuid}/remove
POST https://api.gusto-demo.com/v1/companies/{company_id}/earning_types
GET https://api.gusto-demo.com/v1/companies/{company_id}/earning_types
PUT https://api.gusto-demo.com/v1/companies/{company_id}/earning_types/{earning_type_uuid}
DELETE https://api.gusto-demo.com/v1/companies/{company_id}/earning_types/{earning_type_uuid}
GET https://api.gusto-demo.com/v1/companies/{company_id}/payrolls
GET https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}
PUT https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}
PUT https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}/prepare
GET https://api.gusto-demo.com/v1/companies/{company_id}/contractor_payments
GET https://api.gusto-demo.com/v1/companies/{company_id}/contractor_payments/{contractor_payment_id}
POST https://api.gusto-demo.com/v1/companies/{company_id}/company_benefits
GET https://api.gusto-demo.com/v1/companies/{company_id}/company_benefits
GET https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}
PUT https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}
DELETE https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}
GET https://api.gusto-demo.com/v1/benefits
GET https://api.gusto-demo.com/v1/benefits/{benefit_id}
GET https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}/summary
GET https://api.gusto-demo.com/v1/benefits/{benefit_id}/requirements
POST https://api.gusto-demo.com/v1/companies/{company_id}/employees
GET https://api.gusto-demo.com/v1/companies/{company_id}/employees
GET https://api.gusto-demo.com/v1/employees/{employee_id}
PUT https://api.gusto-demo.com/v1/employees/{employee_id}
DELETE https://api.gusto-demo.com/v1/employees/{employee_id}
GET https://api.gusto-demo.com/v1/employees/{employee_id}/custom_fields
GET https://api.gusto-demo.com/v1/employees/{employee_uuid}/time_off_activities
GET https://api.gusto-demo.com/v1/employees/{employee_id}/terminations
GET https://api.gusto-demo.com/v1/employees/{employee_id}/rehire
GET https://api.gusto-demo.com/v1/employees/{employee_id}/employment_history
GET https://api.gusto-demo.com/v1/employees/{employee_id}/home_addresses
POST https://api.gusto-demo.com/v1/employees/{employee_id}/home_addresses
GET https://api.gusto-demo.com/v1/home_addresses/{home_address_uuid}
PUT https://api.gusto-demo.com/v1/home_addresses/{home_address_uuid}
DELETE https://api.gusto-demo.com/v1/home_addresses/{home_address_uuid}
GET https://api.gusto-demo.com/v1/employees/{employee_id}/work_addresses
POST https://api.gusto-demo.com/v1/employees/{employee_id}/work_addresses
GET https://api.gusto-demo.com/v1/work_addresses/{work_address_uuid}
PUT https://api.gusto-demo.com/v1/work_addresses/{work_address_uuid}
DELETE https://api.gusto-demo.com/v1/work_addresses/{work_address_uuid}
POST https://api.gusto-demo.com/v1/employees/{employee_id}/jobs
GET https://api.gusto-demo.com/v1/employees/{employee_id}/jobs
GET https://api.gusto-demo.com/v1/jobs/{job_id}
PUT https://api.gusto-demo.com/v1/jobs/{job_id}
DELETE https://api.gusto-demo.com/v1/jobs/{job_id}
GET https://api.gusto-demo.com/v1/jobs/{job_id}/compensations
POST https://api.gusto-demo.com/v1/jobs/{job_id}/compensations
GET https://api.gusto-demo.com/v1/compensations/{compensation_id}
PUT https://api.gusto-demo.com/v1/compensations/{compensation_id}
DELETE https://api.gusto-demo.com/v1/compensations/{compensation_id}
POST https://api.gusto-demo.com/v1/employees/{employee_id}/employee_benefits
GET https://api.gusto-demo.com/v1/employees/{employee_id}/employee_benefits
GET https://api.gusto-demo.com/v1/employee_benefits/{employee_benefit_id}
PUT https://api.gusto-demo.com/v1/employee_benefits/{employee_benefit_id}
DELETE https://api.gusto-demo.com/v1/employee_benefits/{employee_benefit_id}
POST https://api.gusto-demo.com/v1/employees/{employee_id}/ytd_benefit_amounts_from_different_company
POST https://api.gusto-demo.com/v1/employees/{employee_id}/garnishments
GET https://api.gusto-demo.com/v1/employees/{employee_id}/garnishments
GET https://api.gusto-demo.com/v1/garnishments/{garnishment_id}
PUT https://api.gusto-demo.com/v1/garnishments/{garnishment_id}
Serving 300,000+ businesses, Gusto API is the preferred HR and payroll solutions provider for many global names, including:
Following is a list of FAQs that can help guide your Gusto API integration journey:
Undoubtedly, there are several categories of applications which can benefit from integrating with Gusto API. Listing a few for developers to get an idea:
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.
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.
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.
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:
POST https://apisandbox.paylocity.com/api/v1/deduction
DELETE https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}/{startDate}
GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions
GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}
POST https://apisandbox.paylocity.com/api/v1/companies/{companyId}/onboarding/employees
GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}
PUT https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}
DELETE https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}
GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes
POST https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes
PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/additionalRates
GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/codes/{codeResource}
GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/customfields/{category}
GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/directDeposit
GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings
PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings
GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate}
DELETE https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate}
GET
https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}
PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/emergencyContacts
PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/benefitSetup
GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees
POST https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees
GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}
PATCH https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}
GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/sensitivedata
PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/sensitivedata
GET https://dc1demogwext.paylocity.com/apiHub/benefits/v1/companies/{companyId}/retirementPlans/{planId}/checks/{checkDate}
36,000+ customers use Paylocity for the HR and payroll needs, including:
A quick glance on the common FAQs that developers have about Paylocity API can help you accelerate your integration journey:
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:
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.
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.
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.
As a developer or the representative of an organization seeking to integrate with Keka API, it is important to understand the endpoints that you will be using eventually for data exchange, both when it comes to read APIs (getting data from Keka) as well as write APIs (providing data to Keka).
GET https://{company}.{environment}.com/api/v1/hris/employees
POST https://{company}.{environment}.com/api/v1/hris/employees
GET https://{company}.{environment}.com/api/v1/hris/employees/{id}
GET https://{company}.{environment}.com/api/v1/hris/employees/updatefields
PUT https://{company}.{environment}.com/api/v1/hris/employees/{id}/personaldetails
PUT https://{company}.{environment}.com/api/v1/hris/employees/{id}/jobdetails
GET https://{company}.{environment}.com/api/v1/hris/groups
GET https://{company}.{environment}.com/api/v1/hris/grouptypes
GET https://{company}.{environment}.com/api/v1/hris/departments
GET https://{company}.{environment}.com/api/v1/hris/locations
GET https://{company}.{environment}.com/api/v1/hris/jobtitles
GET https://{company}.{environment}.com/api/v1/hris/currencies
GET https://{company}.{environment}.com/api/v1/hris/noticeperiods
GET https://{company}.{environment}.com/api/v1/time/leavetypes
GET https://{company}.{environment}.com/api/v1/time/leavebalance
GET https://{company}.{environment}.com/api/v1/time/leaverequests
POST https://{company}.{environment}.com/api/v1/time/leaverequests
GET https://{company}.{environment}.com/api/v1/time/attendance
GET https://{company}.{environment}.com/api/v1/time/capturescheme
GET https://{company}.{environment}.com/api/v1/time/holidayscalendar
GET https://{company}.{environment}.com/api/v1/payroll/salarycomponents
GET https://{company}.{environment}.com/api/v1/payroll/paygroups
GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles
GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/payregister
GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches
GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches/{payBatchId}/payments
PUT https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches/{payBatchId}/payments
GET https://{company}.{environment}.com/api/v1/payroll/paygrades
GET https://{company}.{environment}.com/api/v1/payroll/paybands
GET https://{company}.{environment}.com/api/v1/psa/clients
POST https://{company}.{environment}.com/api/v1/psa/clients
GET https://{company}.{environment}.com/api/v1/psa/clients/{id}
PUT https://{company}.{environment}.com/api/v1/psa/clients/{id}
GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/phases
POST https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/phases
GET https://{company}.{environment}.com/api/v1/psa/projects
POST https://{company}.{environment}.com/api/v1/psa/projects
GET https://{company}.{environment}.com/api/v1/psa/projects/{id}
PUT https://{company}.{environment}.com/api/v1/psa/projects/{id}
GET https://{company}.{environment}.com/api/v1/psa/projects/{id}/allocations
GET https://{company}.{environment}.com/api/v1/psa/projects/{id}/timeentries
GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks
POST https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks
PUT https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks/{taskId}
GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks/{taskId}/timeentries
GET https://{company}.{environment}.com/api/v1/pms/timeframes
GET https://{company}.{environment}.com/api/v1/pms/goals
PUT https://{company}.{environment}.com/api/v1/pms/goals/{goalId}/progress
GET https://{company}.{environment}.com/api/v1/pms/badges
POST https://{company}.{environment}.com/api/v1/pms/praise
GET https://{company}.{environment}.com/api/v1/expense/categories
GET https://{company}.{environment}.com/api/v1/expense/claims
GET https://{company}.{environment}.com/api/v1/expensepolicies
GET https://{company}.{environment}.com/api/v1/assets
GET https://{company}.{environment}.com/api/v1/assets/types
GET https://{company}.{environment}.com/api/v1/assets/categories
GET https://{company}.{environment}.com/api/v1/assets/conditions
Keka, as an HRMS tool, is widely used with 5000+ customers, including:
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
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.
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.
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.
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.
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:
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 -
Some endpoints include:
Authentication: Basic Auth over HTTPS
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:
Authentication: Basic Auth
Click here for more information.
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:
Authentication: HTTP Basic Authentication over HTTPS
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:
Some endpoints include:
Authentication: OAuth 2.0 and Basic Auth
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
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
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.
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.
Check out some of the top FAQs for Greenhouse API to scale your integration process:
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:
When this header is not present, it means there is only a single page of results, which is the first page.
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.
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.
Building Greenhouse API integration on your own can be challenging, especially for a team with limited engineering resources. For example,
Here are some of the common Greenhouse API use cases that would help you evaluate your integration need:
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)
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 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:
Check out this detailed documentation to get started with DarwinBox API integration.
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
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.
Top Lever API endpoints to access particular information are as follows:
Check out this detailed documentation for more endpoints.
Check out the top FAQs for Lever API to help you get started
To learn how you can get started with Lever API integration, check out this detailed guide.
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
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.
Some endpoints for SAP SuccessFactors API include:
Here’s a guide for more information.
Here are some of the top SuccessFactors FAQs that can help you understand this integration better:
To get started with SAP SuccessFactors API, click here for more information.
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
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.
Let’s quickly look at the endpoints for Rippling API across fields like companies, employees, groups, etc.
To know more about Rippling API endpoints, click here.
Check out some of the top Rippling API FAQs to address some of your initial queries:
Here is a quick guide to help you get started with integration for 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
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.
There are several endpoints within Namely API, based on how different fields are grouped for data filtering.
Defining how profiles of employees are organized within Namely API. The Groups and Teams Endpoints can be found here.
Categorization of posts on Namely Home Feed across events, announcements, birthdays, anniversaries, new arrival, etc. All Home Feed endpoints are mentioned here.
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.
Defining the valid values and formats for countries and subdivisions for use and reference. All Namely Systems Information Endpoints can be found here.
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.
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.
Here are a few FAQs which can help you in your Namely API journey.
For a quick guide on integrating with Namely API, click here.
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