HR Cloud software is a comprehensive digital platform hosted on the cloud, designed to streamline and enhance human resources functions. It offers a suite of tools and services that assist organizations in managing critical HR tasks such as employee data management, recruitment, onboarding, payroll, and benefits administration. By leveraging HR Cloud software, companies can efficiently handle performance management, time and attendance tracking, learning and development, and compliance reporting. This software is indispensable for HR professionals, managers, and employees across various industries, aiming to optimize workforce management and boost organizational efficiency.

HR Cloud offers a suite of RESTful APIs that enable developers to programmatically access and manage various HR-related data and services within the HR Cloud platform. These APIs facilitate seamless integration with external applications, allowing for operations such as retrieving employee information, managing departments, and handling documents.

Key Features of HR Cloud APIs:

• RESTful Architecture: The APIs adhere to REST principles, utilizing standard HTTP methods (GET, POST, PUT, DELETE) for resource manipulation. This design ensures compatibility and ease of integration with various systems. HRCloud Help
• JSON Payloads: Data is exchanged in JSON format, providing a lightweight and easily parsable structure for client applications. HRCloud Help
• Versioning Support: The APIs support versioning, allowing organizations to adopt new features at their own pace without disrupting existing integrations. HRCloud Help

Core HR API:

The Core HR API provides programmatic access to common HR activities, including:

• Employee Management: Retrieve and update employee information, including attachments and forms.
• Department and Division Management: Access and modify details of departments and divisions.
• Location Management: Manage location data pertinent to the organization.
• Task Management: Create and manage tasks assigned to employees.

Detailed documentation for the Core HR API is available, outlining endpoints, request structures, and response formats. HRCloud Help

Employee API:

The Employee API focuses on operations related to employee data, such as:

• Retrieving Employee Details: Fetch comprehensive information about employees, including personal and employment-related data.
• Creating and Updating Employees: Programmatically add new employees or update existing employee records.

Comprehensive details and usage examples for the Employee API can be found in the official documentation. HR Cloud Support

Authentication and Authorization:

HR Cloud APIs implement robust authentication and authorization mechanisms to ensure secure access. Developers must obtain appropriate credentials and tokens to interact with the APIs, adhering to the security protocols outlined in the documentation. HR Cloud Support

Integration with External Systems:

HR Cloud's APIs facilitate integration with various external systems, such as Microsoft Power Automate, enabling organizations to automate workflows and synchronize HR data across platforms. Microsoft Learn

‍

HR Cloud API Endpoints

Applicant APIs

• POST /xApplicant : Create an Applicant
• post /xApplicant/Resource : Post XApplicant Resource
• GET https://corehr-api.hrcloud.com/v1/cloud/xApplicant : Retrieve Applicants
• GET https://corehr-api.hrcloud.com/v1/cloud/xApplicant/:applicantId : Retrieve Single Applicant
• PUT https://corehr-api.hrcloud.com/v1/cloud/xApplicant/Upsert : Upsert Applicant

Bonus History APIs

• GET https://corehr-api.hrcloud.com/v1/cloud/xBonusHistory : Retrieve Bonus History
• GET https://corehr-api.hrcloud.com/v1/cloud/xBonusHistory/:bonusid : Get One Bonus

Department APIs

• GET https://corehr-api.hrcloud.com/v1/cloud/xDepartment : GET departments
• GET https://corehr-api.hrcloud.com/v1/cloud/xDepartment/:departmentId : GET single department
• PUT https://corehr-api.hrcloud.com/v1/cloud/xDepartment/Upsert : Update or Create a Department

Division APIs

• GET https://corehr-api.hrcloud.com/v1/cloud/xDivision : GET divisions
• PUT https://corehr-api.hrcloud.com/v1/cloud/xDivision/Upsert : PUT division upsert

Employee APIs

• POST https://corehr-api.hrcloud.com/v1/cloud/xEmployee : Create Employee with Mapping Parameters
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId : GET single employee
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments : Retrieve Employee Attachments
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/:attachmentId : Get one attachment of an employee
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/download : GET employee attachment download all
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/download/:attachmentId : Download Employee Attachment
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/download/:attachmentId1,:attachmentId2,... : GET employee attachment download multiple
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/form/:formType/:formId : Get one form of an employee
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/forms : Retrieve Employee Forms
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/forms/download : Download All Employee Forms
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/forms/download/:formType1_formId1,:formType2_formId2 : GET employee forms download single or multiple
• PUT https://corehr-api.hrcloud.com/v1/cloud/xEmployee/Picture : PUT employee picture
• POST https://corehr-api.hrcloud.com/v1/cloud/xEmployee/Resource/Picture : Upload Employee Picture
• PUT https://corehr-api.hrcloud.com/v1/cloud/xEmployee/Upsert : PUT employee param upsert

Employment Status History APIs

• POST https://corehr-api.hrcloud.com/v1/cloud/xEmploymentStatusHistory : Create Employment Status History
• GET https://corehr-api.hrcloud.com/v1/cloud/xEmploymentStatusHistory/:employmentid : Get Employment Status Change Details

Location APIs

• PUT https://corehr-api.hrcloud.com/v1/cloud/xLocation : Update Location
• GET https://corehr-api.hrcloud.com/v1/cloud/xLocation/:locationId : GET single division
• PUT https://corehr-api.hrcloud.com/v1/cloud/xLocation/Upsert : PUT location

Position APIs

• POST https://corehr-api.hrcloud.com/v1/cloud/xPosition : Create a Position
• GET https://corehr-api.hrcloud.com/v1/cloud/xPosition/:positionId : GET single position
• PUT https://corehr-api.hrcloud.com/v1/cloud/xPosition/Upsert : PUT position upsert

Position History APIs

• GET https://corehr-api.hrcloud.com/v1/cloud/xPositionHistory : GET position history
• GET https://corehr-api.hrcloud.com/v1/cloud/xPositionHistory/:positionid : GET one position history

Rehire History APIs

• GET https://corehr-api.hrcloud.com/v1/cloud/xRehireHistory : Retrieve Rehire History
• GET https://corehr-api.hrcloud.com/v1/cloud/xRehireHistory/:rehireid : Get One Rehire

Salary History APIs

• GET https://corehr-api.hrcloud.com/v1/cloud/xSalaryHistory : Retrieve Salary History
• GET https://corehr-api.hrcloud.com/v1/cloud/xSalaryHistory/:salaryid : Get One Salary

Task APIs

• GET https://corehr-api.hrcloud.com/v1/cloud/xTask : Retrieve a list of tasks
• GET https://corehr-api.hrcloud.com/v1/cloud/xTask/:taskId : GET single task
• POST https://corehr-api.hrcloud.com/v1/cloud/xTask/Portal : Create a Plain Task

‍

Get Started with HR Cloud API Integration

‍

About Knit

Knit API offers a convenient solution for quick and seamless integration with HR Cloud API. Our AI-powered integration platform allows you to build any HR Cloud API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to HR Cloud API.‍

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

Greythr software is a comprehensive human resources management solution tailored to optimize and streamline HR processes for organizations of varying sizes. It offers a suite of functionalities that cover essential HR domains, including Employee Information Management, Payroll, Leave Management, and Attendance Management. By automating these processes, Greythr enables HR departments to enhance efficiency, reduce manual errors, and ensure compliance with payroll regulations, making it an indispensable tool for modern businesses.

One of the standout features of Greythr is its ability to facilitate seamless onboarding and offboarding workflows, alongside providing an HR Help Desk, Letters, Tasks & Checklists, and Payroll Compliance tools. These features collectively empower organizations to manage their workforce effectively, from hiring to retirement. Furthermore, the Greythr API integration process allows businesses to extend the software's capabilities, ensuring that it can be customized to meet specific organizational needs. This flexibility makes Greythr a versatile choice for companies looking to enhance their HR operations.

Key highlights of GreytHR APIs

‍

GreytHR API Endpoints

Attendance

• GET https://api.greythr.com/attendance/v2/employee/insights : Get Attendance Summary for All Employees
• GET https://api.greythr.com/attendance/v2/employee/muster : Get Attendance Muster Details for All Employees
• GET https://api.greythr.com/attendance/v2/employee/{employee-id}/insights : Get Employee Attendance Summary
• GET https://api.greythr.com/attendance/v2/employee/{employee-id}/muster : Get Employee Attendance Muster
• GET https://api.greythr.com/attendance/v2/employee/{employee-id}/swipes : Get Employee Attendance Muster Raw Swipes

Employee Documents

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

Employee Information

• GET https://api.greythr.com/employee/v2/employees : Get All Employees
• GET https://api.greythr.com/employee/v2/employees/addresses/{address-type} : Get All Employee Address Details
• GET https://api.greythr.com/employee/v2/employees/assets : Get All Employee Asset Details
• GET https://api.greythr.com/employee/v2/employees/bank : Get All Employee Bank Details
• GET https://api.greythr.com/employee/v2/employees/categories : Get All Employee Positions Details
• GET https://api.greythr.com/employee/v2/employees/families/{relationtype-id} : Get Employees Family Details
• GET https://api.greythr.com/employee/v2/employees/identities/{identity-code} : Get All Employee Identity Details
• GET https://api.greythr.com/employee/v2/employees/lookup?q={Employee+No.%2FEmail%2FGuid%2FAccess+card%2F+Personal+email} : Employee Lookup
• GET https://api.greythr.com/employee/v2/employees/org-tree : Get Orgtree Reporting Structure
• GET https://api.greythr.com/employee/v2/employees/personal : Get All Employee Personal Details
• GET https://api.greythr.com/employee/v2/employees/pf : Get All Employee PF & ESI Details
• GET https://api.greythr.com/employee/v2/employees/profile : Get All Employee Profile Details
• GET https://api.greythr.com/employee/v2/employees/qualifications : Get All Employee Qualifications Details
• GET https://api.greythr.com/employee/v2/employees/separation : Get All Employee Separation Details
• GET https://api.greythr.com/employee/v2/employees/statutory/india : Get All Employee Statutory Details
• GET https://api.greythr.com/employee/v2/employees/work : Get All Employee Work Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id} : Update Employee Information
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/addresses/{address-type} : Update Employee Address Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/assets : Get Employee Asset Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/assets/{asset-id} : Update Employee Assets
• POST https://api.greythr.com/employee/v2/employees/{employee-id}/bank : Add Employee Bank Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/categories : Get Employee Positions Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/families : Get Employee Family Details
• DELETE https://api.greythr.com/employee/v2/employees/{employee-id}/families/{relation-id} : Delete Family Member Details
• POST https://api.greythr.com/employee/v2/employees/{employee-id}/family-benefit : Add Employee Family Benefits
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/identities : Get Employee's All Identity Details
• DELETE https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code} : Delete Employee Identity
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/org-tree : Get Employee Manager Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/personal : Get Employee Personal Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/pf : Get Employee PF & ESI Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/profile : Update Employee Profile Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications : Get Employee Qualifications Details
• DELETE https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications/{qualification-id} : Delete Employee Qualifications Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/separation : Update Employee Separation Details
• PUT https://api.greythr.com/employee/v2/employees/{employee-id}/statutory/india : Update Employee Statutory Details
• GET https://api.greythr.com/employee/v2/employees/{employee-id}/work : Get Employee Work Details

HR

• POST https://api.greythr.com/hr/v2/lov : Post List of Values for Categories
• GET https://api.greythr.com/hr/v2/lov/banks/{bankId}/branches : Get Bank Branch Details
• POST https://api.greythr.com/hr/v2/lov/org/entities : Add greytHR Org Entities

Leave

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

Payroll

• GET https://api.greythr.com/payroll/v2/employees/handentry : Get All Employee Hand Entry Salary Items
• GET https://api.greythr.com/payroll/v2/employees/resettlement/{payrollMonth} : Get Employees Resettlement for a Month
• GET https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}} : Get Salary Statement for a Month
• GET https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}}/{employee-id} : Get Salary Statement for an Employee for a Month
• GET https://api.greythr.com/payroll/v2/employees/{employee-id} : Get Employee Hand Entry Salary Items
• POST https://api.greythr.com/payroll/v2/form16/download : Form16 Download API
• GET https://api.greythr.com/payroll/v2/pay-period/list : Get Pay Period API For The Financial Year
• GET https://api.greythr.com/payroll/v2/pay-period?inputDate=2024-02-11 : Get Pay Period For Particular Date
• GET https://api.greythr.com/payroll/v2/payslip/download?encoded=true : Generate Payslip For Employee
• GET https://api.greythr.com/payroll/v2/salary/repository : Get Salary Repository Items
• GET https://api.greythr.com/payroll/v2/salary/revision/difference/employees/{employee-id} : Get Salary Revision Difference
• POST https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id} : Add Salary Revision
• GET https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id}/{status} : Get Salary Revision History
• POST https://api.greytip.com/payroll/v2/loan : Create Loan for Employee
• DELETE https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id} : Delete Attendance Snapshot

User

• GET https://api.greythr.com/user/v2/users : Get Users List
• POST https://api.greythr.com/user/v2/users/{userid}/auth : User SSO Authentication

Miscellaneous

• POST https://api.greytip.com/pengo/v1/admin/payslip/download?encoded=false : Payslip Download
• GET https://apigee-test.greythr.com/employee/v2/employees/employeeId/card-details/cardId : Get Employee Card Details
• POST https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details : Add Employee Card Details
• DELETE https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details/{cardId} : Delete Employee Card Details

GreytHR API FAQ

1. How can I access the greytHR API?
   • Answer: To access the greytHR API, you need to create an API user within the greytHR Admin portal. Navigate to Settings > My Account > API Users, then click on Create API User. Fill in the required details and assign appropriate roles to define the API user's permissions. GreyHR Freshdesk
2. What authentication method does the greytHR API use?
   • Answer: The greytHR API utilizes OAuth 2.0 for authentication. After creating an API user, you can obtain an access token by sending a POST request to the /uas/v1/oauth2/client-token endpoint, using the client ID and client credentials obtained during the registration process. This access token must be included in the Authorization header of subsequent API requests. Postman
3. Are there rate limits for the greytHR API?
   • Answer: The official documentation does not specify explicit rate limits for the greytHR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
4. Can I retrieve employee data using the greytHR API?
   • Answer: Yes, the greytHR API provides endpoints to retrieve employee data. For example, you can use the GET /employee/v2/employees endpoint to fetch a list of all employees, with options to filter based on parameters like state, status, and categories. Postman
5. Does the greytHR API support webhooks for real-time data updates?
   • Answer: As of the latest available information, the greytHR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.

‍

Get Started with GreytHR API Integration

1. Create an API User: Administrators can create API users through the greytHR Admin portal by navigating to Settings > My Account > API Users and clicking "Create API User." GreyHR Freshdesk
2. Enable API Roles: After creating an API user, enable the necessary roles by selecting "API User Provisioning" and granting the required access permissions. GreyHR Freshdesk
3. Generate API Credentials: Once roles are assigned, generate API credentials (Client ID and Client Secret) for the API user to facilitate authentication. GreyHR Freshdesk
4. Authenticate Using OAuth 2.0: Utilize the Client ID and Client Secret to obtain an access token via the OAuth 2.0 protocol, which will be used to authenticate API requests. Postman
5. Explore API Endpoints: Familiarize yourself with various API endpoints to perform operations such as retrieving employee details, managing leave records, and processing attendance data. GreyHR API Documentation

Additional Resources:

• Postman Collection: greytHR offers a Postman collection to facilitate testing and understanding of API endpoints. Postman
• Developer Community: Engage with the greytHR developer community for support, insights, and updates related to the APIs.

‍

About Knit

Knit API offers a convenient solution for quick and seamless integration with GreytHR API. Our AI-powered integration platform allows you to build any GreytHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to GreytHR API.‍

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

Darwinbox is a cutting-edge cloud-based Human Resources Management Software (HRMS) that revolutionizes the Human Capital Management (HCM) landscape. Designed to streamline and automate a myriad of HR processes, Darwinbox enhances both efficiency and the employee experience. This comprehensive platform offers an extensive suite of tools that manage the entire employee lifecycle, from core HR functions such as employee data management and payroll processing to talent management, employee engagement, and workforce management. With advanced analytics and reporting capabilities, Darwinbox empowers organizations to make data-driven decisions, ultimately improving HR efficiency and reducing manual workload.

As a Software as a Service (SaaS) platform, Darwinbox is accessible via the internet, making it a versatile solution for businesses of all sizes. One of the key features that sets Darwinbox apart is its robust API integration capabilities. The Darwinbox API allows seamless integration with other enterprise systems, ensuring a cohesive digital ecosystem. This integration process is crucial for organizations looking to enhance their HR operations by connecting Darwinbox with existing tools and platforms. By leveraging the Darwinbox API, businesses can unlock new levels of efficiency and customization, tailoring the software to meet their unique needs.

Key highlights of Darwinbox APIs

Key Features of Darwinbox APIs:

• Authentication: Darwinbox APIs employ a token-based authentication mechanism. The token is generated using a SHA512 hash of a dynamic string, which includes parameters like the admin email, a unique secret key provided by Darwinbox, and the current epoch timestamp. Postman
• Data Formats: The APIs communicate using JSON, ensuring compatibility with a wide range of programming languages and platforms. Postman
• Comprehensive Documentation: Darwinbox provides detailed API documentation, including guides and references, to assist developers in effectively utilizing the APIs. Darwinbox API Docs
• Integration Capabilities: The platform supports integrations with various external systems, such as recruitment tools, ERP systems, payroll and compliance management, employee rewards, and engagement platforms. This extensibility ensures a seamless user experience across different solutions. Darwinbox

‍

Darwinbox API Endpoints

Attendance

• POST https://{{subdomain}}.darwinbox.in/AttendancePunchesApi : Add Attendance Punches
• POST https://{{subdomain}}.darwinbox.in/attendanceDataApi/backdatedattendance : Add Backdated Attendance
• POST https://{{subdomain}}.darwinbox.in/attendanceDataApi/timesheetdatewise : Employee Timesheet Datewise

Background Verification

• POST https://{{subdomain}}.darwinbox.in/Bgv/candidatedetailv2 : Background Verification - Fetch Candidate Details V2
• POST https://{{subdomain}}.darwinbox.in/Bgv/candidatelistv2 : Background Verification - Fetch Candidate List V2
• POST https://{{subdomain}}.darwinbox.in/Bgv/filedownloadv2 : Background Verification - Download Form Attachments
• POST https://{{subdomain}}.darwinbox.in/Bgv/reportsubmissionv2 : Background Verification - Submit Verification Report V2

Employee Management

• POST https://{{subdomain}}.darwinbox.in/Employeedocs/StandardDoc : Add Standard Documents
• POST https://{{subdomain}}.darwinbox.in/UpdateEmployeeDetails/approvedconfirmation : Fetch Approved Confirmation Data
• POST https://{{subdomain}}.darwinbox.in/UpdateEmployeeDetails/update : Add/Update Employee Email ID
• POST https://{{subdomain}}.darwinbox.in/importapi/activate : Activate Pending Employee
• POST https://{{subdomain}}.darwinbox.in/importapi/add : Add Pending Employee
• POST https://{{subdomain}}.darwinbox.in/importapi/deactivate : Deactivate Active Employee
• POST https://{{subdomain}}.darwinbox.in/importapi/deletePendingEmployee : Delete Pending Employee
• POST https://{{subdomain}}.darwinbox.in/importapi/educationdetails : Add or Update Employee Education Details
• POST https://{{subdomain}}.darwinbox.in/importapi/pastworkdetails : Add or Update Past Work Details
• POST https://{{subdomain}}.darwinbox.in/importapi/processCustomSection : Add or Update Custom Section

Project Management

• POST https://{{subdomain}}.darwinbox.in/importapi/addProject : Add or Update Project
• POST https://{{subdomain}}.darwinbox.in/importapi/addProjectTeam : Add Project Team
• POST https://{{subdomain}}.darwinbox.in/importapi/addactivity : Add Activity
• POST https://{{subdomain}}.darwinbox.in/importapi/assignpermissions : Assign Permissions

Organizational Management

• POST https://{{subdomain}}.darwinbox.in/importapi/addLocations : Create Location Masters
• POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createCostCenter : Create Cost Center Master
• POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createbusinessunit : Add or Update Business Unit Master
• POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createdepartment : Add or Update Department Master
• POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createdesignation : Create Designation
• POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createdesignationname : Create or Update Designation Name
• POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createposition : Create or Update Position Master

Recruitment

• POST https://{{subdomain}}.darwinbox.in/JobsApiv2/candidatetag : Add Tags to Candidate Profile V3

Travel

• POST https://{{subdomain}}.darwinbox.in/travelApi/Advance : Fetch Advance Travel Requests

Darwinbox API FAQs

‍

1. How can I access the Darwinbox API?
   • Answer: To access the Darwinbox API, you need to be a privileged user with appropriate permissions. Access is provided on a request-only basis. You can reach out to Darwinbox at integrations@darwinbox.in to request API access. Darwinbox API Docs
2. What authentication method does the Darwinbox API use?
   • Answer: The Darwinbox API uses a token-based authentication mechanism. To generate the required token, you need the following parameters:
     • Email: Admin Email ID provided by Darwinbox.
     • Timestamp: Current 10-digit epoch timestamp.
     • Secret Key: Unique secret key provided by Darwinbox.The token is generated by creating a SHA512 hash of the concatenated string: email + secretkey + timestamp. Postman
3. Are there rate limits for the Darwinbox API?
   • Answer: The official documentation does not specify explicit rate limits for the Darwinbox API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
4. Can I retrieve employee data using the Darwinbox API?
   • Answer: Yes, the Darwinbox API provides endpoints to retrieve employee data. For example, you can use the POST /masterapi/employee endpoint to fetch employee data, either as a full load or based on specific criteria such as last modified date. Postman
5. Does the Darwinbox API support webhooks for real-time data updates?
   • Answer: As of the latest available information, the Darwinbox API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services like Knit that provide webhook functionality.

‍

Get Started with Darwinbox API Integration

1. Access Privileges: Darwinbox APIs are accessible only to privileged users. Access is provided on a request-only basis, ensuring secure and controlled integration. Darwinbox API Docs
2. Authentication Setup: To authenticate API requests, generate a SHA512 hash using your admin email, the unique secret key provided by Darwinbox, and the current epoch timestamp. This hash is then included in your API requests to validate access. Postman
3. Explore API Endpoints: Darwinbox offers a variety of API endpoints across different modules, including Employee Core, Recruitment, Onboarding, Attendance, Leave, Performance, Compensation, Expenses, Recognition, Travel, Vibe and Pulse, and HR Documents. Each module provides specific functionalities to manage corresponding HR processes. Postman
4. Utilize Postman Collections: Darwinbox provides a public workspace on Postman, featuring ready-to-use requests and documentation. This resource aids in testing and understanding API endpoints. Postman

Additional Resources:

• Integration Guides: For detailed integration instructions, refer to the Darwinbox Integrations page, which outlines how to become a partner and explore various integration categories and brands. Darwinbox
• Developer Community: Engage with the Darwinbox developer community for support, insights, and updates related to the APIs. Postman

‍

About Knit

Knit API offers a convenient solution for quick and seamless integration with Darwinbox API. Our AI-powered integration platform allows you to build any Darwinbox API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Darwinbox API.‍

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

Xero is a leading cloud-based accounting software platform tailored for small and medium-sized businesses. It offers an extensive suite of financial management tools, including invoicing, bank reconciliation, expense tracking, and financial reporting. These features simplify the financial management process, allowing businesses to efficiently handle their finances. Additionally, Xero provides payroll management tools to streamline employee payments, tax calculations, and ensure compliance with local payroll regulations. Its inventory management capabilities enable businesses to track stock levels and manage product sales effectively.

One of Xero's standout features is its integration capabilities, particularly through the Xero API. This allows seamless connectivity with a wide range of third-party applications, such as payment processors, CRM systems, and e-commerce platforms, enhancing the software's functionality. The user-friendly interface and real-time data access make it easy for users to manage their business finances from anywhere. Xero's versatility and comprehensive features make it an invaluable tool for businesses looking to streamline their financial operations and gain insights into their financial health.

Key highlights of Xero APIs

‍

Xero API Endpoints

Payments

• POST /Payments/{PaymentID} : Delete Payment
• PUT /payments : Apply Payments to Invoices, Credit Notes, Prepayments, or Overpayments
• GET https://api.xero.com/api.xro/2.0/Payments : Retrieve Payments for Invoices and Credit Notes
• PUT https://api.xero.com/api.xro/2.0/Payments/{Guid}/History : Add Notes to a Batch Payment

Contacts

• PUT https://api.example.com/contacts : Create Contact Records
• POST https://api.xero.com/api.xro/2.0/Contacts : Create or Update Contacts
• POST https://api.xero.com/api.xro/2.0/Contacts/{ContactID}/Attachments/{FileName} : Uploading an Attachment to a Contact in Xero
• GET https://api.xero.com/api.xro/2.0/Contacts/{Guid}/History : Retrieving Contact History
• GET https://api.xero.com/api.xro/2.0/contacts : GET Contacts

Accounts

• GET https://api.xero.com/api.xro/2.0/Accounts : GET Accounts
• POST https://api.xero.com/api.xro/2.0/Accounts/{AccountID} : Archive Accounts
• PUT https://api.xero.com/api.xro/2.0/Accounts/{account_id}/Attachments/{file_name} : Uploading an Attachment to an Account in Xero

Bank Transactions

• POST https://api.xero.com/api.xro/2.0/BankTransactions : Create or Update Bank Transactions
• POST https://api.xero.com/api.xro/2.0/BankTransactions/{BankTransactionID} : Deleting Spend and Receive Money Transactions
• GET https://api.xero.com/api.xro/2.0/BankTransactions/{Guid}/History : Retrieving History of Bank Transactions
• POST https://api.xero.com/api.xro/2.0/BankTransactions/{bankTransactionID}/Attachments/{fileName} : Uploading an Attachment to a Bank Transaction

Bank Transfers

• GET https://api.xero.com/api.xro/2.0/BankTransfers : GET BankTransfers
• POST https://api.xero.com/api.xro/2.0/BankTransfers/{bank_transfer_id}/Attachments/{file_name} : Uploading an Attachment to a Bank Transfer

Batch Payments

• POST https://api.xero.com/api.xro/2.0/BatchPayments : Update Batch Payment Status to DELETED

Branding Themes

• GET https://api.xero.com/api.xro/2.0/BrandingThemes : Get Branding Themes
• POST https://api.xero.com/api.xro/2.0/BrandingThemes/{BrandingThemeID}/PaymentServices : Apply Payment Service to Branding Theme

Contact Groups

• POST https://api.xero.com/api.xro/2.0/ContactGroups : Create or Update Contact Groups
• PUT https://api.xero.com/api.xro/2.0/ContactGroups/{ContactGroupID}/Contacts : PUT ContactGroups
• DELETE https://api.xero.com/api.xro/2.0/ContactGroups/{ContactGroupID}/Contacts/{ContactID} : DELETE ContactGroups

Credit Notes

• GET https://api.xero.com/api.xro/2.0/CreditNotes : GET Credit Notes
• PUT https://api.xero.com/api.xro/2.0/CreditNotes/{CreditNoteID}/Allocations : Creating and Allocating CreditNotes
• DELETE https://api.xero.com/api.xro/2.0/CreditNotes/{CreditNoteID}/Allocations/{AllocationID} : Delete CreditNotes Allocations
• POST https://api.xero.com/api.xro/2.0/CreditNotes/{CreditNoteID}/Attachments/{FileName} : Uploading an Attachment to a Credit Note
• PUT https://api.xero.com/api.xro/2.0/CreditNotes/{Guid}/History : Add Notes to a Credit Note

Currencies

• GET https://api.xero.com/api.xro/2.0/Currencies : GET Currencies

Employees

• PUT https://api.example.com/employees/{employeeId} : PUT Employees API
• POST https://api.xero.com/api.xro/2.0/Employees : Create or Update Employee Records

Expense Claims

• POST https://api.xero.com/api.xro/2.0/ExpenseClaims : Submit or Update Expense Claims
• GET https://api.xero.com/api.xro/2.0/ExpenseClaims/{Guid}/History : Retrieving Expense Claim History

Invoice Reminders

• GET https://api.xero.com/api.xro/2.0/InvoiceReminders/Settings : Check Invoice Reminders Settings

Invoices

• POST https://api.xero.com/api.xro/2.0/Invoices : Create or Update Invoices
• GET https://api.xero.com/api.xro/2.0/Invoices/{Guid}/History : Retrieve Invoice History
• POST https://api.xero.com/api.xro/2.0/Invoices/{InvoiceID}/Attachments/{FileName} : Uploading an Attachment to an Invoice
• POST https://api.xero.com/api.xro/2.0/Invoices/{InvoiceID}/Email : Email an Invoice via Xero API
• GET https://api.xero.com/api.xro/2.0/Invoices/{InvoiceID}/OnlineInvoice : Retrieve Online Invoice URL

Items

• GET https://api.xero.com/api.xro/2.0/Items : GET Items
• GET https://api.xero.com/api.xro/2.0/Items/{Guid}/History : Retrieving Item History
• DELETE https://api.xero.com/api.xro/2.0/Items/{ItemID} : Delete Items

Journals

• GET https://api.xero.com/api.xro/2.0/Journals : GET Journals

Linked Transactions

• POST https://api.xero.com/api.xro/2.0/LinkedTransactions : Create or Update Linked Transactions
• DELETE https://api.xero.com/api.xro/2.0/LinkedTransactions/{LinkedTransactionID} : Delete Linked Transaction

Manual Journals

• PUT https://api.example.com/manualjournals : Create New Manual Journals
• POST https://api.xero.com/api.xro/2.0/ManualJournals : Create or Update Manual Journal
• POST https://api.xero.com/api.xro/2.0/ManualJournals/{manualJournalID}/Attachments/{fileName} : Uploading an Attachment to a Manual Journal

Organisation

• GET https://api.xero.com/api.xro/2.0/Organisation : Get Organisation Details
• GET https://api.xero.com/api.xro/2.0/Organisation/Actions : GET Organisation Actions
• GET https://api.xero.com/api.xro/2.0/Organisation/{OrganisationID}/CISSettings : Retrieve CIS Settings for an Organisation

Overpayments

• GET https://api.xero.com/api.xro/2.0/Overpayments : GET Overpayments
• PUT https://api.xero.com/api.xro/2.0/Overpayments/{Guid}/History : Add Notes to an Overpayment
• PUT https://api.xero.com/api.xro/2.0/Overpayments/{OverpaymentID}/Allocations : Allocate Overpayment to Outstanding Invoices
• DELETE https://api.xero.com/api.xro/2.0/Overpayments/{OverpaymentID}/Allocations/{AllocationID} : Deleting Overpayments Allocations

Payment Services

• GET https://api.xero.com/api.xro/2.0/PaymentServices : Get Payment Services

Prepayments

• GET https://api.xero.com/api.xro/2.0/Prepayments : Retrieve Prepayments
• GET https://api.xero.com/api.xro/2.0/Prepayments/{Guid}/History : Retrieving Prepayment History
• PUT https://api.xero.com/api.xro/2.0/Prepayments/{PrepaymentID}/Allocations : Allocate Prepayment to Outstanding Invoices
• DELETE https://api.xero.com/api.xro/2.0/Prepayments/{PrepaymentID}/Allocations/{AllocationID} : Deleting Prepayments Allocations

Purchase Orders

• GET https://api.xero.com/api.xro/2.0/PurchaseOrders : Retrieve Purchase Orders
• GET https://api.xero.com/api.xro/2.0/PurchaseOrders/{Guid}/History : Retrieve Purchase Order History

Quotes

• PUT https://api.example.com/quotes/{quoteId} : PUT Quotes API
• GET https://api.xero.com/api.xro/2.0/Quotes : GET Quotes

Receipts

• PUT https://api.xero.com/api.xro/2.0/Receipts : PUT Receipts
• PUT https://api.xero.com/api.xro/2.0/Receipts/{Guid}/History : Add Notes to a Receipt
• POST https://api.xero.com/api.xro/2.0/Receipts/{receipt_id}/Attachments/{file_name} : Uploading a Receipt Image

Repeating Invoices

• POST https://api.xero.com/api.xro/2.0/RepeatingInvoices : Create or Delete Repeating Invoice Templates
• GET https://api.xero.com/api.xro/2.0/RepeatingInvoices/{Guid}/History : Retrieving Repeating Invoice History

Reports

• GET https://api.xero.com/api.xro/2.0/Reports : Get GST Report
• GET https://api.xero.com/api.xro/2.0/Reports/AgedPayablesByContact : Aged Payables By Contact
• GET https://api.xero.com/api.xro/2.0/Reports/AgedReceivablesByContact : Aged Receivables By Contact
• GET https://api.xero.com/api.xro/2.0/Reports/BalanceSheet : Balance Sheet Report API
• GET https://api.xero.com/api.xro/2.0/Reports/BankSummary : Bank Summary Report
• GET https://api.xero.com/api.xro/2.0/Reports/BudgetSummary : Budget Summary
• GET https://api.xero.com/api.xro/2.0/Reports/ExecutiveSummary : Get Executive Summary Report
• GET https://api.xero.com/api.xro/2.0/Reports/ProfitAndLoss : Profit and Loss Report
• GET https://api.xero.com/api.xro/2.0/Reports/TenNinetyNine : 1099 Report Retrieval
• GET https://api.xero.com/api.xro/2.0/Reports/TrialBalance : Get Trial Balance Report

Tax Rates

• POST https://api.xero.com/api.xro/2.0/TaxRates : Create or Update Tax Rate

Tracking Categories

• PUT https://api.xero.com/api.xro/2.0/TrackingCategories : Create Tracking Categories and Options
• POST https://api.xero.com/api.xro/2.0/TrackingCategories/{TrackingCategoryID} : Update Tracking Categories and Options

Users

• GET https://api.xero.com/api.xro/2.0/Users : GET Users

Budgets

• GET https://api.xero.com/api.xro/2.0/budgets : GET Budgets

Attachments

• GET https://api.xero.com/api.xro/2.0/{Endpoint}/{Guid}/Attachments/ : GET Attachments
• POST https://api.xero.com/api.xro/2.0/{Endpoint}/{Guid}/Attachments/{Filename} : Upload Attachments to Xero

Document History

• GET https://api.xero.com/api.xro/2.0/{Endpoint}/{Guid}/history : Get Document History

Sample API

• GET https://api.example.com/v1/resource : Sample API Documentation
• POST https://api.example.com/v1/sample : Sample API

Xero API FAQs

1. How do I get started with the Xero API?
   • Answer: To begin using the Xero API, follow these steps:some text
     • Sign up for a free Xero account.
     • Enable the Xero demo company.
     • Add your OAuth 2.0 application by logging into Xero and navigating to the developer portal.
   • Source: Getting Started Guide — Xero Developer
2. What authentication method does the Xero API use?
   • Answer: The Xero API utilizes OAuth 2.0 for authentication. You'll need to create an OAuth 2.0 app in the Xero developer portal to obtain the necessary credentials for API access.
   • Source: Frequently Asked Questions — Xero Developer
3. Are there rate limits for the Xero API?
   • Answer: Yes, Xero enforces rate limits to ensure fair usage:some text
     • Minute Limit: 60 calls per minute.
     • Daily Limit: 5,000 calls per day.
     • Concurrent Requests: A maximum of 5 concurrent requests.
   • Source: Frequently Asked Questions — Xero Developer
4. Can I retrieve invoices using the Xero API?
   • Answer: Yes, you can retrieve invoices by making a GET request to the /Invoices endpoint of the Accounting API. You can filter and sort invoices using various parameters to suit your needs.
   • Source: Accounting API Overview — Xero Developer
5. Does the Xero API support webhooks?
   • Answer: Yes, Xero supports webhooks, allowing your application to receive real-time notifications about specific events, such as changes to invoices or contacts.‍
   • Source: Frequently Asked Questions — Xero Developer

Get Started with Xero API Integration

1. Create a Xero Account: If you don't have one, sign up for a Xero account.
2. Register Your Application: Access the Xero Developer Center to create a new application, which will provide you with a Client ID and Client Secret necessary for authentication. Xero Developer
3. Authenticate Using OAuth 2.0: Implement the OAuth 2.0 flow to obtain an access token, allowing your application to interact with the Xero API on behalf of users. Xero Developer
4. Utilize SDKs and Libraries: Leverage available SDKs and libraries to simplify API integration within your application. GitHub GitHub
5. Explore API Endpoints: Familiarize yourself with various API endpoints to perform operations such as creating invoices, managing contacts, and retrieving financial reports. Xero Developer

Additional Resources:

• API Explorer: Xero offers an API Explorer to facilitate testing and understanding of API endpoints. Xero Developer
• Developer Community: Engage with the Xero developer community for support, insights, and updates related to the API. Xero Developer

About Knit

For quick and seamless integration with Xero API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Xero API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 Xero API.‍

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

Freshworks is a leading provider of AI-powered software solutions, dedicated to enhancing business operations across customer service, IT service management (ITSM), enterprise service management (ESM), and sales and marketing. By focusing on improving customer engagement and streamlining sales processes, Freshworks offers a suite of tools designed to automate marketing efforts and optimize IT service delivery. Their solutions are versatile, catering to businesses of all sizes and industries, making them a popular choice for organizations seeking to improve efficiency and customer satisfaction.

One of the standout offerings from Freshworks is Freshsales, a comprehensive sales CRM that empowers businesses to manage their sales processes effectively. With features like lead scoring, email tracking, and workflow automation, Freshsales helps sales teams close deals faster and more efficiently. The Freshsales API plays a crucial role in this ecosystem by allowing seamless integration with other tools and platforms, enabling businesses to customize and extend their CRM capabilities to suit their unique needs. This API integration process is vital for businesses looking to leverage Freshsales to its fullest potential.

Key highlights of Freshsales APIs

Freshsales API Endpoints

Appointments

• POST https://domain.myfreshworks.com/crm/sales/api/appointments : Create an Appointment
• GET https://domain.myfreshworks.com/crm/sales/api/appointments/:appointment_id : View an Appointment
• DELETE https://domain.myfreshworks.com/crm/sales/api/appointments/[:appointment_id] : Delete an Appointment

Contacts

• POST https://domain.myfreshworks.com/crm/sales/api/contacts : Create a Contact
• DELETE https://domain.myfreshworks.com/crm/sales/api/contacts/[id] : Delete a Contact
• GET https://domain.myfreshworks.com/crm/sales/api/contacts/[id]/activities.json : List all Activities
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/[id]/clone : Clone a Contact
• DELETE https://domain.myfreshworks.com/crm/sales/api/contacts/[id]/forget : Forget a Contact
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/bulk_assign_owner : Bulk Assign Owner to Contacts
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/bulk_destroy : Bulk Delete Contacts
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/bulk_upsert : Bulk Upsert Contact
• GET https://domain.myfreshworks.com/crm/sales/api/contacts/lists/[id] : Fetch All Contacts from the List
• POST https://domain.myfreshworks.com/crm/sales/api/contacts/upsert : Upsert a Contact
• GET https://domain.myfreshworks.com/crm/sales/api/contacts/view/[view_id] : List All Contacts
• GET https://domain.myfreshworks.com/crm/sales/api/contacts/{id}/document_associations : List all Files and Links

CPQ Documents

• POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents : Create a Document
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id] : Update a Document
• DELETE https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]/forget : Forget a Document
• GET https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]/related_products : Get Related Products
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]/restore : Restore a Document
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]?include=products : Edit Products of the Document
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_assign : Bulk-assign Owner to Documents
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_delete : Bulk-delete Documents
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_restore : Bulk-restore Documents
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_update : Bulk-update Documents

Products

• POST https://domain.myfreshworks.com/crm/sales/api/cpq/products : Create a Product
• DELETE https://domain.myfreshworks.com/crm/sales/api/cpq/products/[id] : Delete a Product
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/products/[id]/restore : Restore a Product
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/products/[id]?include=product_pricings : Delete Prices of the Product
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_assign : Bulk-assign Owner to Products
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_delete : Bulk-delete Products
• POST https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_restore : Bulk-restore Products
• PUT https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_update : Bulk-update Products

Custom Module

• POST https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name] : Create a Record in Custom Module
• DELETE https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/[id] : Delete a Record in Custom Module
• POST https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/[id]/clone : Clone a Custom Module Record
• DELETE https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/[id]/forget : Forget a Record in Custom Module
• POST https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/bulk_destroy : Bulk-delete Records in Custom Module
• GET https://domain.myfreshworks.com/crm/sales/api/custom_module/[module_name]/view/[view_id] : Fetch Records from a Specific View in a Custom Module

Deals

• POST https://domain.myfreshworks.com/crm/sales/api/deals : Create a Deal
• PUT https://domain.myfreshworks.com/crm/sales/api/deals/[id] : Update a Deal
• POST https://domain.myfreshworks.com/crm/sales/api/deals/[id]/clone : Clone a Deal
• DELETE https://domain.myfreshworks.com/crm/sales/api/deals/[id]/forget : Forget a Deal
• PUT https://domain.myfreshworks.com/crm/sales/api/deals/[id]?include=products : Add Products to the Deal
• POST https://domain.myfreshworks.com/crm/sales/api/deals/bulk_destroy : Bulk Delete Deals
• POST https://domain.myfreshworks.com/crm/sales/api/deals/bulk_upsert : Bulk Upsert Deal
• POST https://domain.myfreshworks.com/crm/sales/api/deals/upsert : Upsert a Deal
• GET https://domain.myfreshworks.com/crm/sales/api/deals/view/[view_id] : List All Deals

Documents and Links

• POST https://domain.myfreshworks.com/crm/sales/api/document_links : Create a Link
• POST https://domain.myfreshworks.com/crm/sales/api/documents : Create a File

Job Status

• GET https://domain.myfreshworks.com/crm/sales/api/job_statuses/[id] : Job Status Tracking API

Marketing Lists

• GET https://domain.myfreshworks.com/crm/sales/api/lists : Fetch All Marketing Lists
• PUT https://domain.myfreshworks.com/crm/sales/api/lists/[id] : Update a Marketing List
• PUT https://domain.myfreshworks.com/crm/sales/api/lists/[list_id]/add_contacts : Copy Contacts to List
• PUT https://domain.myfreshworks.com/crm/sales/api/lists/[list_id]/move_contacts : Move Contacts from List
• PUT https://domain.myfreshworks.com/crm/sales/api/lists/[list_id]/remove_contacts : Remove Contacts From List

Lookup

• GET https://domain.myfreshworks.com/crm/sales/api/lookup : Lookup Search API

Notes

• POST https://domain.myfreshworks.com/crm/sales/api/notes : Create a Note
• DELETE https://domain.myfreshworks.com/crm/sales/api/notes/[id] : Delete a Note

Phone Calls

• POST https://domain.myfreshworks.com/crm/sales/api/phone_calls : Create a Manual Call Log

Sales Accounts

• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts : Create an Account
• GET https://domain.myfreshworks.com/crm/sales/api/sales_accounts/[id] : View an Account
• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/[id]/clone : Clone an Account
• DELETE https://domain.myfreshworks.com/crm/sales/api/sales_accounts/[id]/forget : Forget an Account
• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/bulk_destroy : Bulk Delete Accounts
• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/bulk_upsert : Bulk Upsert Account
• POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/upsert : Upsert an Account
• GET https://domain.myfreshworks.com/crm/sales/api/sales_accounts/view/[view_id] : List All Accounts

Sales Activities

• GET https://domain.myfreshworks.com/crm/sales/api/sales_activities : List All Sales Activities
• GET https://domain.myfreshworks.com/crm/sales/api/sales_activities/[:sales_activity_id] : View a Sales Activity

Settings

• GET https://domain.myfreshworks.com/crm/sales/api/settings/:entity_type/forms : Get a list of all fields in a custom module
• GET https://domain.myfreshworks.com/crm/sales/api/settings/contacts/fields : List All Contact Fields
• GET https://domain.myfreshworks.com/crm/sales/api/settings/deals/fields : List All Deal Fields
• POST https://domain.myfreshworks.com/crm/sales/api/settings/module_customizations : Create Custom Modules
• GET https://domain.myfreshworks.com/crm/sales/api/settings/module_customizations/[id] : Get a list of custom modules
• GET https://domain.myfreshworks.com/crm/sales/api/settings/sales_accounts/fields : List All Account Fields
• GET https://domain.myfreshworks.com/crm/sales/api/settings/sales_activities/fields : List All Sales Activity Fields

Tasks

• GET https://domain.myfreshworks.com/crm/sales/api/tasks : List All Tasks
• DELETE https://domain.myfreshworks.com/crm/sales/api/tasks/[:task_id] : Delete Task
• GET https://domain.myfreshworks.com/crm/sales/api/tasks/[id] : View Task Details

‍

Freshsales API FAQs

How do I obtain an API key in Freshsales?

• Answer: To obtain your API key in Freshsales:some text
  1. Log in to your Freshsales account.
  2. Click on your profile picture in the top-right corner and select Profile Settings.
  3. Navigate to the API Settings tab.
  4. Your API key will be displayed under Your API key.
• Source: Freshsales API Documentation

What authentication method does the Freshsales API use?

• Answer: The Freshsales API uses token-based authentication. Include your API key in the Authorization header of your HTTP requests, formatted as Token token=YOUR_API_KEY.
• Source: Freshsales API Documentation

Are there rate limits for the Freshsales API?

• Answer: Yes, Freshsales enforces rate limits to ensure fair usage. The default limit is 1000 API requests per hour. Exceeding this limit will result in a 429 Too Many Requests response.
• Source: Freshsales API Rate Limits

Can I retrieve contact data using the Freshsales API?

• Answer: Yes, you can retrieve contact data by making a GET request to the /api/contacts endpoint. This will return a list of contacts and their details.
• Source: Freshsales API Documentation

Does the Freshsales API support webhooks?

• Answer: As of the latest available information, Freshsales does not natively support webhooks. However, you can use the API to poll for changes or integrate with third-party services that provide webhook functionality to achieve similar outcomes.
• Source: Freshsales API Documentation

Get Started with Freshsales API Integration

‍

Additional Resources:

• Postman Collection: Freshsales offers a Postman collection to facilitate testing and understanding of API endpoints. Postman
• Developer Community: Engage with the Freshsales developer community for support, insights, and updates related to the API. Freshworks Developers

‍

About Knit

For quick and seamless integration with Freshsales API, Knit API offers a convenient solution. Our AI powered integration platform allows you to build any Freshsales API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 Freshsales API.

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

‍

FreshBooks is a leading cloud-based accounting software tailored specifically for small businesses and freelancers. It offers an intuitive platform that simplifies financial management through its web and mobile applications. With FreshBooks, users can efficiently handle invoicing, expense tracking, time tracking, online payments, financial reporting, and project management. This makes it an ideal solution for small business owners, freelancers, and self-employed professionals, especially those in service-oriented industries such as consulting, design, and agency work. By streamlining accounting tasks, FreshBooks enables users to dedicate more time to their core business activities, enhancing productivity and growth.

One of the standout features of FreshBooks is its robust API integration capabilities. The FreshBooks API allows developers to seamlessly connect the software with other applications, facilitating data synchronization and automation of workflows. This integration potential is particularly beneficial for businesses looking to customize their accounting processes and improve operational efficiency. As you explore the FreshBooks API, you'll discover how it can be leveraged to create a more cohesive and efficient business ecosystem.

Key highlights of FreshBooks APIs

• Authentication: Utilizes OAuth 2.0 for secure authentication, ensuring only authorized applications can access user data.
• Data Formats: Communicates using JSON, compatible with a wide range of programming languages and platforms.
• Extensive Documentation: Provides comprehensive guides and references for developers.
• SDKs and Libraries: Offers official SDKs for Python and Node.js, with community-supported libraries for Java and PHP.

‍

FreshBooks API Endpoints

Accounting

• GET https://api.freshbooks.com/accounting/account/<accountId>/bill_payments/bill_payments : List Bill Payments
• PUT https://api.freshbooks.com/accounting/account/<accountId>/bill_payments/bill_payments/<billPaymentId> : Edit Payment to Bill
• GET https://api.freshbooks.com/accounting/account/<accountId>/bill_vendors/bill_vendors : Get Vendors
• PUT https://api.freshbooks.com/accounting/account/<accountId>/bill_vendors/bill_vendors/<vendorId> : Delete Vendor
• POST https://api.freshbooks.com/accounting/account/<accountId>/bills/bills : Create a Bill
• GET https://api.freshbooks.com/accounting/account/<accountId>/bills/bills/ : Get Bills
• PUT https://api.freshbooks.com/accounting/account/<accountId>/bills/bills/<billId> : Delete Bill
• POST https://api.freshbooks.com/accounting/account/<accountId>/expenses/expenses?include%5B%5D=attachment : Create Expense With Attachment
• POST https://api.freshbooks.com/accounting/account/<accountId>/invoices/invoices : Create Invoice with Attachment
• GET https://api.freshbooks.com/accounting/account/<accountId>/invoices/invoices/<invoiceId> : Get Single Invoice
• GET https://api.freshbooks.com/accounting/account/<accountId>/users/clients : List Clients
• PUT https://api.freshbooks.com/accounting/account/<accountId>/users/clients/ : Update Existing Client Profile with Secondary Contacts
• GET https://api.freshbooks.com/accounting/account/<accountId>/users/clients/<customerId> : Get Single Client
• GET https://api.freshbooks.com/accounting/account/<accountId>/users/clients/?include%5B%5D=recent_contacts : Get Client Profile and Associated Secondary Contacts
• POST https://api.freshbooks.com/accounting/account/<account_id>/journal_entries/journal_entries : Add Journal Entry
• GET https://api.freshbooks.com/accounting/account/<account_id>/journal_entries/journal_entry_details : Get Journal Entry Details
• GET https://api.freshbooks.com/accounting/account/<account_id>/journal_entry_accounts/journal_entry_accounts : Get Accounts
• GET https://api.freshbooks.com/accounting/account/<account_id>/projects/tasks : Listing Tasks
• PUT https://api.freshbooks.com/accounting/account/<account_id>/projects/tasks/<task_id> : Delete a Task
• GET https://api.freshbooks.com/accounting/account/<accountid> : Example Searches for Accounting Endpoint
• POST https://api.freshbooks.com/accounting/account/<accountid>/credit_notes/credit_notes : Create Credit Note
• PUT https://api.freshbooks.com/accounting/account/<accountid>/credit_notes/credit_notes/<creditid> : Delete Credit
• POST https://api.freshbooks.com/accounting/account/<accountid>/estimates/estimates : Create Single Estimate
• GET https://api.freshbooks.com/accounting/account/<accountid>/estimates/estimates/<estimateid> : Get Single Estimate
• PUT https://api.freshbooks.com/accounting/account/<accountid>/estimates/estimates/<id> : Delete Single Estimate
• GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/categories : List Expense Categories
• GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/categories/<id> : Get Single Expense Category
• GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/expenses : List Expenses
• GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/expenses/<expenseid> : Get Single Expense
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles : Listing Invoice Profiles
• PUT https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles/<profileid> : Delete an Invoice Profile
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles?include%5B%5D=next_issue_date : Including the next issue date
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles?search%5Bclientid%5D=23482 : Search example with clientid
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles?search%5Bcurrency_code%5D=USD : Search example with currency code
• GET https://api.freshbooks.com/accounting/account/<accountid>/invoices/invoices : Example Sort (accounting endpoint)
• GET https://api.freshbooks.com/accounting/account/<accountid>/items/items : List Items
• PUT https://api.freshbooks.com/accounting/account/<accountid>/items/items/<id> : Update Single Item
• GET https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/ : List Other Income Entries
• DELETE https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id> : Delete Other Income Entry
• GET https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<incomeid> : Get Single Other Income
• GET https://api.freshbooks.com/accounting/account/<accountid>/payments/payments : List Payments
• PUT https://api.freshbooks.com/accounting/account/<accountid>/payments/payments/<id> : Update Single Payment
• GET https://api.freshbooks.com/accounting/account/<accountid>/systems/gateways : List Gateways
• DELETE https://api.freshbooks.com/accounting/account/<accountid>/systems/gateways/<id> : Delete Single Gateway
• GET https://api.freshbooks.com/accounting/account/<accountid>/systems/systems/<id> : Get System
• GET https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes : List Taxes
• PUT https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id> : Update Single Tax
• PUT https://api.freshbooks.com/accounting/account/<accountid>/users/clients/<clientid> : Remove all Secondary Contacts
• GET https://api.freshbooks.com/accounting/account/<accountid>/users/staffs : List Staff
• GET https://api.freshbooks.com/accounting/account/<accountid>/users/staffs/<id> : Get Single Staff
• GET https://api.freshbooks.com/account/{account_id}/projects/tasks : Search Examples for Tasks
• POST https://api.freshbooks.com/accounting/businesses/{business_uuid}/ledger_accounts/accounts : Create Account
• GET https://api.freshbooks.com/accounting/businesses/{bussiness_uuid}/ledger_accounts/accounts : Get Single Account
• GET https://api.freshbooks.com/accounting/businesses/{bussiness_uuid}/ledger_accounts/accounts/{accountId} : Get Account

Authentication

• GET https://api.freshbooks.com/auth/api/v1/businesses/<business_id>/team_members : List Team Members
• GET https://api.freshbooks.com/auth/api/v1/businesses/<business_id>/team_members/<team_member_uuid> : Get Single Team Member
• GET https://api.freshbooks.com/auth/api/v1/users/me : Get Companies Information
• POST https://api.freshbooks.com/auth/oauth/revoke : Revoking a Bearer/Refresh Token
• POST https://api.freshbooks.com/auth/oauth/token : Get Bearer token via refresh code

Comments

• POST https://api.freshbooks.com/comments/business/<businessid>/service : Create a Service
• PUT https://api.freshbooks.com/comments/business/<businessid>/service/<service_id>/rate : Update a Service Rate
• GET https://api.freshbooks.com/comments/business/<businessid>/service/<serviceid> : Get Single Service
• GET https://api.freshbooks.com/comments/business/<businessid>/service/<serviceid>/rate : Get Single Service Rate
• GET https://api.freshbooks.com/comments/business/<businessid>/services : List Services

Events

• GET https://api.freshbooks.com/events/account/<account_id>/events/callbacks : List all webhook callbacks
• PUT https://api.freshbooks.com/events/account/<account_id>/events/callbacks/<callback_id> : Resend verification code

Payments

• POST https://api.freshbooks.com/payments/account/<account_id>/invoice/<invoice_id>/payment_options : Add payment gateway to the invoice
• GET https://api.freshbooks.com/payments/account/<account_id>/payment_options : Check Online Payment Gateways Available
• GET https://api.freshbooks.com/payments/account/<accountid>/invoice/<invoiceid>/payment_options : See Payment Options on an Invoice
• GET https://api.freshbooks.com/payments/account/<accountid>/payment_options?entity_type=invoice : Get the Default Invoice Payment Options

Projects

• POST https://api.freshbooks.com/projects/business/<business_id>/project : Create a Single Project
• DELETE https://api.freshbooks.com/projects/business/<business_id>/project/<project_id> : Delete a Single Project
• GET https://api.freshbooks.com/projects/business/<business_id>/projects : List Projects
• GET https://api.freshbooks.com/projects/business/<businessid>/projects : Example Sort (project endpoint)

Test

• GET https://api.freshbooks.com/test : Test Call

Time Tracking

• GET https://api.freshbooks.com/timetracking/business/<business_id>/time_entries : List Time Entries Update From A Particular Time
• PUT https://api.freshbooks.com/timetracking/business/<business_id>/time_entries/<time_entry_id> : Update a Time Entry
• GET https://api.freshbooks.com/timetracking/business/<business_id>/time_entries/{time_entrie_id} : Get A Single Time Entry
• GET https://api.freshbooks.com/timetracking/business/<businessid> : Example Searches for Timetracking Endpoint

Uploads

• POST https://api.freshbooks.com/uploads/account/<accountId>/attachments : Upload Attachment
• POST https://api.freshbooks.com/uploads/account/<account_id>/attachments : Upload Invoice Attachment
• POST https://api.freshbooks.com/uploads/account/<account_id>/images : Upload Logo / Banner

‍

Freshbooks API FAQs

How do I authenticate with the FreshBooks API?

• Answer: The FreshBooks API uses OAuth 2.0 for authentication. To authenticate:some text
  1. Create an OAuth application in your FreshBooks account to obtain a Client ID and Client Secret.
  2. Direct users to authorize your application, which provides an authorization code.
  3. Exchange the authorization code for an access token.
  4. Use the access token in the Authorization header of your API requests.
• Source: FreshBooks API Introduction

What are the rate limits for the FreshBooks API?

• Answer: FreshBooks enforces rate limits to ensure fair usage and maintain system performance. While specific rate limits are not publicly detailed, it's recommended to implement error handling for potential rate limiting responses and to contact FreshBooks support for detailed rate limit information.
• Source: FreshBooks API Introduction

Can I retrieve client information using the FreshBooks API?

• Answer: Yes, the FreshBooks API provides endpoints to manage clients. For example, you can use the /accounting/account/<accountId>/users/clients endpoint to list all clients associated with your account.
• Source: Client API | FreshBooks

Does the FreshBooks API support webhooks for real-time data updates?

• Answer: Yes, FreshBooks supports webhooks, allowing you to receive real-time notifications for specific events, such as when an invoice is created or updated. You can configure webhook subscriptions to specify which events you want to receive notifications for.
• Source: Webhook Callbacks - FreshBooks API

Are there official SDKs or client libraries for the FreshBooks API?

• Answer: Yes, FreshBooks provides official SDKs to facilitate integration:some text
  • Node.js SDK: An officially maintained wrapper for Node.js developers.
• Source: Getting Started with FreshBooks NodeJS SDK

Get Started with Frehbooks API Integration

Create a FreshBooks Account: Sign up for a FreshBooks account if you don’t already have one.

Register Your Application: Access the FreshBooks Developer Hub to create a new application and get your Client ID and Client Secret.

Authenticate Using OAuth 2.0: Implement the OAuth 2.0 flow to obtain an access token, enabling API interactions on behalf of users.

Utilize SDKs and Libraries: Leverage the available SDKs for easier integration.

Explore API Endpoints: Familiarize yourself with the API endpoints to create clients, send invoices, and track expenses.

‍

Additional Resources:

• Postman Collection: FreshBooks Postman Workspace for testing and understanding API endpoints.
• API Libraries and SDKs: Official and community-supported libraries are available on the FreshBooks API Libraries page.
• Developer Community: Join the FreshBooks Developer Community for support and updates.

About Knit

Knit API offers a convenient solution for quick and seamless integration with Freshbooks API. Our AI-powered integration platform allows you to build any Freshbooks API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Freshbooks API.‍

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

HiBob is a cutting-edge human resources management software that revolutionizes the way businesses handle HR tasks. Known as "Bob," this platform offers a comprehensive suite of features designed to streamline HR processes and enhance employee management. From onboarding workflows to time and attendance management, HiBob provides tools that simplify the complexities of HR operations. Its robust capabilities also include compensation analysis, performance reviews, and workforce planning, making it an indispensable asset for modern HR departments.

One of the standout features of HiBob is its ability to integrate seamlessly with other systems through the HiBob API. This integration capability allows businesses to connect HiBob with their existing software infrastructure, ensuring a smooth flow of data and enhancing operational efficiency. By leveraging the HiBob API, companies can customize their HR processes, automate repetitive tasks, and gain valuable insights into their workforce, ultimately driving better decision-making and fostering a more engaged and productive work environment.

Key highlights of HiBob APIs

The HiBob API offers developers a comprehensive suite of tools to integrate and automate various human resources processes within their applications. Below are the key highlights of the HiBob API:

Core Functionalities:

• Employee Management: Access and manage detailed information about employees, including personal details, employment history, and contact information. HiBob API Documentation
• Time Off Management: Retrieve and handle data related to employee leave requests, balances, and histories.
• Reports Generation: Generate and access various reports to gain insights into HR metrics and organizational data.
• Onboarding Integration: Integrate with Applicant Tracking Systems (ATS) to streamline the onboarding process for new hires. HiBob API Documentation

Integration Use Cases:

• Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems. HiBob API Documentation
• Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
• Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.

Supported Protocols:

• RESTful API: The HiBob API follows REST principles, facilitating straightforward HTTP requests and responses.

Authentication Mechanisms:

• Service User Authentication: Secure access is granted through service user credentials, which include a unique ID and token. HiBob API Documentation

Rate Limiting Policies:

• Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

For comprehensive information and to get started with the HiBob API, refer to their official API documentation.

‍

HiBob API Endpoints

Attendance

• POST https://api.hibob.com/v1/attendance/import/{importMethod} : Import Attendance Data

Avatars

• PUT https://api.hibob.com/v1/avatars/{employeeId} : Upload Employee Avatar

Bulk Data

• GET https://api.hibob.com/v1/bulk/people/employment : Get Historical Employment Entries
• GET https://api.hibob.com/v1/bulk/people/lifecycle : Get Historical Lifecycle Entries for Employees
• GET https://api.hibob.com/v1/bulk/people/salaries : Get Historical Salary Entries
• GET https://api.hibob.com/v1/bulk/people/work : Get Historical Work Entries for Employees

Company

• GET https://api.hibob.com/v1/company/named-lists : Get Company Named Lists
• POST https://api.hibob.com/v1/company/named-lists/{listName} : Create a New Item in a Named List
• DELETE https://api.hibob.com/v1/company/named-lists/{listName}/{itemId} : Delete Named List Item
• GET https://api.hibob.com/v1/company/people/fields : Retrieve Employee Fields Metadata
• DELETE https://api.hibob.com/v1/company/people/fields/{fieldId} : Delete Company People Field
• GET https://api.hibob.com/v1/company/reports : Get Company Reports
• GET https://api.hibob.com/v1/company/reports/{reportId}/download : Download Company Report
• GET https://api.hibob.com/v1/company/reports/{reportId}/download-async : Asynchronously Generate and Download Report

Documents

• GET https://api.hibob.com/v1/docs/folders/metadata : Get Folder Metadata
• GET https://api.hibob.com/v1/docs/people/{id} : Get Employee Documents and Download Links
• POST https://api.hibob.com/v1/docs/people/{id}/confidential/upload : Upload File to Employee's Confidential Folder
• DELETE https://api.hibob.com/v1/docs/people/{id}/confidential/{docId} : Delete Confidential Document for Employee
• POST https://api.hibob.com/v1/docs/people/{id}/folders/{folderId}/upload : Upload File to Employee's Custom Folder
• DELETE https://api.hibob.com/v1/docs/people/{id}/folders/{folderId}/{docId} : Delete Document from Employee's Custom Folder
• POST https://api.hibob.com/v1/docs/people/{id}/shared/upload : Upload File to Employee's Shared Folder
• DELETE https://api.hibob.com/v1/docs/people/{id}/shared/{docId} : Delete Document from Employee's Shared Folder

Employees

• POST https://api.hibob.com/v1/employees/{employeeId}/invitations : Send Employee Invitation
• POST https://api.hibob.com/v1/employees/{employeeId}/start-date : Set Employee Start Date
• POST https://api.hibob.com/v1/employees/{identifier}/terminate : Terminate Employee
• POST https://api.hibob.com/v1/employees/{identifier}/uninvite : Uninvite Employee

Hiring

• POST https://api.hibob.com/v1/hiring/job-ads/search : Search Active Job Ads on Bob Career Page
• GET https://api.hibob.com/v1/hiring/job-ads/{id} : Get Job Ad Details

Metadata

• GET https://api.hibob.com/v1/metadata/objects/position : Get Position Metadata Fields

Objects

• POST https://api.hibob.com/v1/objects/position/search : Search Company Positions

Onboarding

• GET https://api.hibob.com/v1/onboarding/wizards : Get Onboarding Wizards Information

Payroll

• GET https://api.hibob.com/v1/payroll/history : Get Payroll History

People

• POST https://api.hibob.com/v1/people : Create New Employee Record in Bob
• GET https://api.hibob.com/v1/people/custom-tables/metadata : Get Custom Tables Metadata
• GET https://api.hibob.com/v1/people/custom-tables/metadata/{custom_table_id} : Get Custom Table Metadata
• POST https://api.hibob.com/v1/people/custom-tables/{employee_id}/{custom_table_id} : Create Entry in Custom Table for Employee
• DELETE https://api.hibob.com/v1/people/custom-tables/{employee_id}/{custom_table_id}/{entry_id} : Delete Custom Table Entry
• POST https://api.hibob.com/v1/people/search : Search Employees Data
• PUT https://api.hibob.com/v1/people/{identifier} : Update Employee Record in Bob
• POST https://api.hibob.com/v1/people/{id} : Update Employee Compensation Details
• GET https://api.hibob.com/v1/people/{id}/bank-accounts : Get Employee Bank Account Entries
• DELETE https://api.hibob.com/v1/people/{id}/bank-accounts/{entry_id} : Delete Employee Bank Account Entry
• GET https://api.hibob.com/v1/people/{id}/compensation : Get Employee Compensation Details
• PUT https://api.hibob.com/v1/people/{id}/email : Change Employee Email Address
• POST https://api.hibob.com/v1/people/{id}/employment : Add Employment Entry for Employee
• DELETE https://api.hibob.com/v1/people/{id}/employment/{entry_id} : Delete Employment Entry
• GET https://api.hibob.com/v1/people/{id}/equities : Get Employee Equity Grants
• DELETE https://api.hibob.com/v1/people/{id}/equities/{entry_id} : Delete Equity Entry for Employee
• GET https://api.hibob.com/v1/people/{id}/lifecycle : Get Employee Lifecycle History
• GET https://api.hibob.com/v1/people/{id}/salaries : Get Employee Salary History
• DELETE https://api.hibob.com/v1/people/{id}/salaries/{entry_id} : Delete Employee Salary Entry
• GET https://api.hibob.com/v1/people/{id}/training : Get Employee Training Records
• DELETE https://api.hibob.com/v1/people/{id}/training/{entry_id} : Delete Training Entry for Employee
• POST https://api.hibob.com/v1/people/{id}/variable : Add Variable Payment for Employee
• DELETE https://api.hibob.com/v1/people/{id}/variable/{entry_id} : Delete Variable Entry for Employee
• POST https://api.hibob.com/v1/people/{id}/work : Add Work Entry for Employee
• PUT https://api.hibob.com/v1/people/{id}/work/{entry_id} : Update Employee Work History Entry

Profiles

• GET https://api.hibob.com/v1/profiles : Get Employee Profiles

Tasks

• GET https://api.hibob.com/v1/tasks : Get All Open Tasks for Company
• GET https://api.hibob.com/v1/tasks/people/{id} : Get Employee Tasks
• POST https://api.hibob.com/v1/tasks/{taskId}/complete : Complete Task

Time Off

• POST https://api.hibob.com/v1/timeoff/employees/{id}/adjustments : Create Employee Balance Adjustment
• GET https://api.hibob.com/v1/timeoff/employees/{id}/balance : Retrieve Employee Time Off Balance
• POST https://api.hibob.com/v1/timeoff/employees/{id}/requests : Submit a New Time Off Request
• DELETE https://api.hibob.com/v1/timeoff/employees/{id}/requests/{requestId} : Cancel Time Off Request
• GET https://api.hibob.com/v1/timeoff/outtoday : Get List of People Out Today
• GET https://api.hibob.com/v1/timeoff/policies : Get Time Off Policy Details
• GET https://api.hibob.com/v1/timeoff/policies/names : Get Policy Names for Defined Policy Type
• GET https://api.hibob.com/v1/timeoff/policy-types : Get Policy Type Names
• GET https://api.hibob.com/v1/timeoff/policy-types/{policyType} : Get Policy Type Details
• POST https://api.hibob.com/v1/timeoff/policy-types/{policyType}/reason-codes : Add Reason Codes for Policy Type
• GET https://api.hibob.com/v1/timeoff/requests/changes : Get Time Off Request Changes
• GET https://api.hibob.com/v1/timeoff/whosout : Get Time Off Information for a Date Range

‍

HiBob API FAQs

How do I get started with the HiBob API?

• Answer: To begin using the HiBob API:some text
  1. Set up your account by determining your integration type (e.g., developing for your organization or becoming a Bob Partner).
  2. Obtain service user credentials for authorization.
  3. Utilize the API Reference Guide to test endpoints and develop your application efficiently.
• Source: Getting Started with Bob's API

What authentication method does the HiBob API use?

• Answer: The HiBob API uses service user credentials for authentication. You need to create a service user in Bob, which provides an ID and Token necessary for authorization. These credentials are then used in the HTTP authorization header for API requests.
• Source: API Service Users

Are there rate limits for the HiBob API?

• Answer: Yes, HiBob enforces rate limits to ensure fair usage. While specific limits are not detailed in the provided documentation, it's recommended to implement error handling for potential rate limiting responses and to consult HiBob support for detailed rate limit information.
• Source: Rate Limiting

Can I retrieve employee data using the HiBob API?

• Answer: Yes, you can retrieve employee data using the HiBob API. The /people/search endpoint allows you to access employee fields, including custom fields, based on permissions granted to the service user.
• Source: Read Employee Data

Does the HiBob API support webhooks for real-time data updates?

• Answer: Yes, HiBob supports webhooks, allowing you to subscribe to events in Bob and be notified in real-time when changes occur. This enables you to build event-driven integrations with HiBob.
• Source: Getting Started with Bob Webhooks

Get Started with HiBob API Integration

Knit API offers a convenient solution for quick and seamless integration with HiBob API. Our AI-powered integration platform allows you to build any HiBob API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. 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 HiBob API.‍

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

‍

FingerCheck is a comprehensive cloud-based software solution tailored to meet the needs of small to medium-sized businesses by simplifying and automating HR and payroll tasks. This innovative platform offers a suite of functionalities, including time tracking, payroll processing, and HR management, making it an indispensable tool for businesses looking to streamline their human resources and payroll operations. By leveraging FingerCheck, companies can efficiently manage employee data, ensure accurate payroll processing, and maintain compliance with labor regulations, all within a single, user-friendly interface.

One of the standout features of FingerCheck is its robust API integration capabilities. The FingerCheck API allows businesses to seamlessly integrate the software with their existing systems, enhancing operational efficiency and data accuracy. This integration process is designed to be straightforward, enabling businesses to customize their HR and payroll workflows to better suit their unique needs. As a result, the FingerCheck API not only facilitates smoother data exchange but also empowers businesses to optimize their HR and payroll processes, ultimately contributing to improved productivity and cost savings.

Key highlights of FingerCheck APIs

‍

The Fingercheck API provides developers with a comprehensive suite of tools to integrate and automate various human resources and payroll processes within their applications. Below are the key highlights of the Fingercheck API:

Core Functionalities:

• Employee Management: Add, update, or remove employee records, facilitating seamless integration with your HR systems.
  
• Payroll Processing: Automate salary calculations, tax deductions, and payments to streamline payroll operations.
• Time and Attendance: Track employee work hours, manage schedules, and monitor attendance data efficiently.
  
• Reports Generation: Retrieve various reports, including live status, schedules, absence requests, paid hours, payroll checks, and time card data.
  

Integration Use Cases:

• Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems.
  
• Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
  
• Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.
  

Supported Protocols:

• RESTful API: The Fingercheck API follows REST principles, facilitating straightforward HTTP requests and responses.
  

Authentication Mechanisms:

• API Key and Client Secret Key: Secure access is granted through a unique API key and a client secret key, which are required for authenticating API requests.
  

Rate Limiting Policies:

• Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

For comprehensive information and to get started with the Fingercheck API, refer to their official API documentation.

FingerCheck API Endpoints

Pay On Demand

• POST /AgreeToTermsEmployeeForPayOnDemand : Agree to Terms for Pay On Demand for Employee
• POST /EnrollEmployeeForPayOnDemand : Enroll Employee For Pay On Demand
• POST /api/employee/{employeeNumber}/payondemand/{approveDecline} : Approve or Decline an Employee Pay On-Demand Application
• POST /v1/PayOnDemand/AddPayOnDemandTransactionRequest : Add Pay On Demand Transaction Request
• GET /v1/PayOnDemand/GetEmployeePayOnDemandApplicationByEmployeeNumber/{employeeNumber} : Retrieve Employee Pay On-Demand Application by Employee Number
• GET /v1/PayOnDemand/GetEmployeePayOnDemandTransactionByReferenceNumber/{referenceNumber} : Retrieve Pay On-Demand Transaction by Reference Number
• GET /v1/PayOnDemand/GetEmployeePayOnDemandTransactionsByEmployeeNumber/{employeeNumber} : Retrieve Employee Pay On-Demand Transactions by Employee Number
• POST /v1/PayOnDemand/UpdateEmployeePayOnDemandApplicationByEmployeeNumber/{employeeNumber} : Update Employee Pay On-Demand Application by Employee Number

Employee Management

• DELETE /api/clock/deleteEmployee : Delete Employee From Clock
• GET /api/employee/taxcodes : Auto Loads Employee Tax Codes
• GET /api/employee/{employeeNumber} : Get Employee Details
• DELETE /api/employees/{employeeNumber} : Delete Employee Data from the System
• POST /api/employees/{employeeNumber}/sendToClocks : Send Employee to All Active Clocks
• POST /api/sendEmployeeToClock : Send Employee to Clock
• POST /api/sendInvite : Send Employee a Self Service Invite Email
• POST /v1/Employees/AddEmployee : Add Employee Data to the System
• POST /v1/Employees/AddEmployeeDeduction : Add Employee Deduction Information
• POST /v1/Employees/AddEmployeeDirectDeposit : Add Employee Direct Deposit Information
• POST /v1/Employees/AddEmployeePayRate : Add Employee Pay Rate Information
• DELETE /v1/Employees/DeleteEmployeeDeductions : Delete Employee Deduction Information
• DELETE /v1/Employees/DeleteEmployeeDirectDeposit : Delete Employee Direct Deposit Information
• DELETE /v1/Employees/DeleteEmployeePayRate : Delete Employee Pay Rate
• GET /v1/Employees/GetAllActiveEmployees : Retrieve All Active Employee Data
• GET /v1/Employees/GetAllEmployees : Retrieve All Employee Data
• GET /v1/Employees/GetClocksEnrolledByEmployeeNumber/{employeeNumber} : Get Clocks Enrolled By Employee Number
• GET /v1/Employees/GetEmployeeByEmployeeNumber/{employeeNumber} : Get Employee by Employee Number
• GET /v1/Employees/GetEmployeeClockInfoByEmployeeNumber/{employeeNumber} : Get Employee Clock Info By Employee Number
• GET /v1/Employees/GetEmployeeDeductionsByEmployeeNumber/{employeeNumber} : Get Employee Deductions by Employee Number
• GET /v1/Employees/GetEmployeeDirectDepositsByEmployeeNumber/{employeeNumber} : Retrieve Employee Direct Deposits by Employee Number
• GET /v1/Employees/GetEmployeeLastPunchInfoByEmployeeNumber/{employeeNumber} : Get Employee Last Punch Info by Employee Number
• GET /v1/Employees/GetEmployeePayRatesByEmployeeNumber/{employeeNumber} : Retrieve Employee Pay Rates by Employee Number
• GET /v1/Employees/GetEmployeesByClockSerialNumber/{clockSerialNumber} : Retrieve Employee Data By Clock Serial Number
• POST /v1/Employees/IssueFingercheckPayCard : Generate and Link Pay Card for Employee
• POST /v1/Employees/SynchronizeEmployees : Synchronize Employee Data
• POST /v1/Employees/UpdateEmployee : Update Employee Information
• POST /v1/Employees/UpdateEmployeeClockInfo : Update Employee Clock Information
• POST /v1/Employees/UpdateEmployeeDeduction : Update Employee Deduction Information
• POST /v1/Employees/UpdateEmployeeDirectDeposit : Update Employee Direct Deposit Information
• POST /v1/Employees/UpdateEmployeeForOnOnboarding : Onboard Employee to Payroll
• POST /v1/Employees/UpdateEmployeePayRate : Update Employee Pay Rate

Applicant Tracking

• POST /v1/ApplicantTracking/AddApplicantByApplicantJobID : Add Applicant by Job ID
• GET /v1/ApplicantTracking/GetApplicantJobOpenings : Get Applicant Job Openings

Punch Management

• POST /v1/Punch/AddPaidHour : Add Paid Hours to the System
• POST /v1/Punch/AddPunch : Add Punch to the System
• POST /v1/Punch/AddPunchs : Add Punches to the System
• DELETE /v1/Punch/DeletePunch : Delete Punch from the System
• POST /v1/Punch/EditPunch : Edit Punch in the System
• GET /v1/Punch/GetClockPunchMetaDataListSampleObject : Retrieve Sample List Clock Meta Data Object
• GET /v1/Punch/GetClockPunchMetaDataSampleObject : Retrieve a Sample Clock Meta Data Object
• GET v1/Punch/GetPunchPhotoByPunchPhotoID : Get Punch Photo by Punch Photo ID

Reports

• GET /v1/Reports/GetAllPayrollCheckDetailsForDateRange : Get All Payroll Check Details for a Specified Date Range
• GET /v1/Reports/GetEmployeeActivePTOAccruals : Get Employee Active PTO Accruals
• GET /v1/Reports/GetEmployeeActivePTOAccrualsByEmployeeNumber/{employeeNumber} : Get Employee Active PTO Accruals by Employee Number
• GET /v1/Reports/GetEmployeePTOAccruals : Get Employee PTO Accruals
• GET /v1/Reports/GetEmployeePTOAccrualsByEmployeeNumber/{employeeNumber} : Get Employee PTO Accruals by Employee Number
• GET /v1/Reports/GetEmployeeRatesByStartDate : Get Employee Rates by Start Date
• POST /v1/Reports/PostDownloadGeneralLedgerByCode : Download General Ledger Report by Code
• GET https://developer.fingercheck.com/api/v1/Reports/GetAbsenceRequestsByDate : Get Absence Requests by Date Range
• GET v1/Reports/GetAllAbsenceRequestsForDateRangeByEmployeeNumber : Get All Absence Requests for Date Range by Employee Number
• GET v1/Reports/GetAllPaidHoursForDateRange : Get All Paid Hours for a Specified Date Range
• GET v1/Reports/GetAllPaidHoursForDateRangeByEmployeeNumber : Get All Paid Hours for Date Range by Employee Number
• GET v1/Reports/GetAllPayrollCheckDetailsForDateRangeByEmployeeNumber : Get All Payroll Check Details for Date Range by Employee Number
• GET v1/Reports/GetAllPayrollChecksForDateRange : Get All Payroll Checks for a Specified Date Range
• GET v1/Reports/GetAllPayrollChecksForDateRangeByEmployeeNumber : Get All Payroll Checks for Date Range by Employee Number
• GET v1/Reports/GetAllTimeCardRawDataForDateRange : Get All Time Card Raw Data for Date Range
• GET v1/Reports/GetAllTimeCardRawDataForDateRangeByEmployeeNumber : Get All Time Card Raw Data for Date Range by Employee Number
• GET v1/Reports/GetAllTimeCardsForDateRange : Get All Time Cards for a Specified Date Range
• GET v1/Reports/GetAllTimeCardsForDateRangeByEmployeeNumber : Get All Time Cards for Date Range by Employee Number
• GET v1/Reports/GetEmployeeActiveRates : Get Employee Active Rates
• GET v1/Reports/GetEmployeeActiveRatesByDatesByEmployeeNumber/{employeeNumber} : Get Employee Active Rates by Dates and Employee Number
• GET v1/Reports/GetEmployeeRatesByStartDateByEmployeeNumber/{employeeNumber} : Get Employee Rates by Start Date and Employee Number
• GET v1/Reports/GetExistingSchedulesByDate : Get Existing Schedules by Date Range
• GET v1/Reports/GetLiveStatusByDate?date={date} : Get Live Status by Date
• GET v1/Reports/GetSchedulesByDate : Get Schedules by Date Range

Schedule Management

• DELETE /api/schedule/{timeClockScheduleID} : Delete an Employee Schedule
• DELETE /v1/Schedule/DeleteTimeClockSchedules : Delete Employee Schedules
• POST /v1/Schedule/SynchronizeEmployeeSchedule : Synchronize Employee Schedule Data

Synchronization

• GET /v1/Sync/GetJobList : Retrieve a List of Jobs
• GET /v1/Sync/GetLookupDataListSampleObject : Retrieve a Sample Lookup Meta Data Object
• GET /v1/Sync/GetLookupDataSampleObject : Retrieve a Sample Lookup Entity Meta Data Object
• POST /v1/Sync/SyncCostCenters?level={level} : Sync Cost Centers
• POST /v1/Sync/SyncJobs : Sync Jobs to the System
• GET v1/Sync/GetCostCenterList : Retrieve a List of Cost Centers by Level
• POST v1/Sync/SyncAndUpdateCostCenters?level={level} : Sync and Update Cost Centers

Developer API

• POST https://developer.fingercheck.com/api/v1/Employees/AddEmployee : Add Employee Data to the System
• POST https://developer.fingercheck.com/api/v1/Employees/AddEmployeeDeduction : Add Employee Deduction Information
• GET https://developer.fingercheck.com/api/v1/Employees/GetAllEmployees : Retrieve All Employee Data
• GET https://developer.fingercheck.com/api/v1/Employees/GetEmployeeByEmployeeNumber/{employeeNumber} : Retrieve Employee Data by Employee Number
• GET https://developer.fingercheck.com/api/v1/Employees/GetEmployeeDeductionsByEmployeeNumber/{employeeNumber} : Get Employee Deductions by Employee Number
• GET https://developer.fingercheck.com/api/v1/Employees/GetEmployeeDirectDepositsByEmployeeNumber/{employeeNumber} : Retrieve Employee Direct Deposits by Employee Number
• POST https://developer.fingercheck.com/api/v1/Employees/UpdateEmployee : Update Employee Information
• POST https://developer.fingercheck.com/api/v1/Employees/UpdateEmployeeDeduction : Update Employee Deduction Information
• POST https://developer.fingercheck.com/api/v1/Employees/UpdateEmployeeDirectDeposit : Update Employee Direct Deposit Information
• POST https://developer.fingercheck.com/api/v1/Punch/AddPunch : Add Punch to the System

‍

FingerCheck API FAQs

How do I obtain API keys to access the FingerCheck API?

• Answer: To access the FingerCheck API, you need two key headers
  • APIKEY: A unique key issued to the programmer to access the API web service.
  • ClientSecretKey: Generated on a per-company and per-user basis to define distinct access levels. To obtain these keys, sign in as an administrator to your FingerCheck account, click your profile avatar, select "Account & Preferences," and then click "Generate" in the API Key section.
    Fingercheck Developer

What authentication method does the FingerCheck API use?

• Answer: The FingerCheck API uses a combination of an API key and a Client Secret Key for authentication. These keys must be included in the request headers of your API calls to authenticate and authorize access.
  Fingercheck Developer

Are there rate limits for the FingerCheck API?

• Answer: The official documentation does not specify explicit rate limits for the FingerCheck API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.

Can I retrieve employee data using the FingerCheck API?

• Answer: Yes, the FingerCheck API provides endpoints to retrieve employee data. For example, you can use the GET v1/Reports/GetAllTimeCardsForDateRange endpoint to return all time cards for a specified date range.
  Fingercheck Developer

Does the FingerCheck API support webhooks for real-time data updates?

• Answer: As of the latest available information, the FingerCheck API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.

Get Started with FingerCheck API Integration

Knit API offers a convenient solution for quick and seamless integration with FingerCheck API. Our AI-powered integration platform allows you to build any FingerCheck API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to FingerCheck API.‍

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

Bullhorn is a leading software company specializing in providing web-based solutions tailored for the staffing and recruiting industry. Its comprehensive platform is designed to streamline recruitment processes, automate workflows, and ultimately enhance business growth by increasing placements. By leveraging Bullhorn, staffing professionals can efficiently manage candidate relationships, job orders, and client interactions, all within a single, intuitive interface. This focus on automation and efficiency makes Bullhorn an invaluable tool for recruitment agencies aiming to optimize their operations and achieve better results.

A key feature of Bullhorn's offering is its robust Bullhorn API, which allows for seamless integration with other software systems. This API enables businesses to customize their recruitment processes further and integrate Bullhorn's functionalities with existing tools and platforms. By utilizing the Bullhorn API, companies can enhance their data management capabilities, improve communication between different systems, and create a more cohesive recruitment ecosystem. This integration potential is a significant advantage for organizations looking to tailor their recruitment strategies to meet specific business needs.

Key highlights of Bullhorn APIs

• Easy Data Access:
  • Facilitates straightforward access to Bullhorn's data for seamless integration.
• Automation:
  • Supports workflow automation to boost productivity and efficiency.
• Custom Integration:
  • Allows for tailored integrations to meet specific business needs.
• Real-Time Sync:
  • Ensures up-to-date information across systems with real-time data synchronization.
• Strong Security:
  • Prioritizes data protection and secure transactions.
• Scalable:
  • Accommodates the needs of both small and large organizations.
• Developer-Friendly:
  • Offers comprehensive documentation and support for developers.
• Global Support:
  • Provides assistance to users worldwide.
• Error Handling and Logging:
  • Includes features for troubleshooting and maintaining system integrity.
• Rate Limiting:
  • Implements rate limiting for fair use and system stability.
• Version Control:
  • Supports version control for effective management of changes and updates.
• Data Transformation:
  • Enables data formatting and processing as needed.
• Webhook Support:
  • Allows for event-driven communication and integration.
• Detailed Analytics and Reporting:
  • Offers insights into data and operations through analytics and reporting.
• Sandbox Environment:
  • Provides a testing environment for development without affecting live data.

Bullhorn API Endpoints

Candidate Management

• PUT and PUT {base_url}/entity/Candidate and {base_url}/entity/JobSubmission : Create Candidate and Associate with Job Order
• PUT {base_url}/entity/Candidate/{candidateId} : Attach Documents to Candidate's Application
• GET {base_url}/entity/Candidate/{candidateId}/fileAttachments : Retrieve All Documents Linked to a Candidate Application

Job Submission

• POST {base_url}/entity/JobSubmission/{applicationId} : Create Candidate Note
• GET {base_url}/query/JobSubmission : Retrieve Job Application Details
• GET and GET {base_url}/query/JobSubmission and {base_url}/entity/Appointment/{appointment_id} : Retrieve All Interview Details for an Application
• GET {base_url}/search/JobSubmission : Retrieve All Job Applications

Job Order

• GET {base_url}/query/JobOrder : Retrieve JobOrder Details
• GET {base_url}/search/JobOrder : Retrieve List of Job Orders

Bullhorn API FAQs

How do I get started with the Bullhorn REST API?

• Answer: To begin using the Bullhorn REST API:some text
  1. Obtain OAuth 2.0 credentials by registering your application with Bullhorn.
  2. Use these credentials to authenticate and receive an access token.
  3. Make a login call to the REST API using the access token to obtain a session token (BhRestToken) and a base REST URL for subsequent API requests.
• Source: Get Started with the Bullhorn REST API

What authentication method does the Bullhorn API use?

• Answer: The Bullhorn API utilizes OAuth 2.0 for authentication. After obtaining an access token through the OAuth flow, you perform a REST API login call to receive a session token (BhRestToken) and a base REST URL for further API interactions.
• Source: Get Started with the Bullhorn REST API

Are there rate limits for the Bullhorn API?

• Answer: Yes, Bullhorn enforces rate limits to ensure fair usage. While specific limits are not publicly documented, it's recommended to implement error handling for potential 429 Too Many Requests responses and to contact Bullhorn support for detailed rate limit information.
• Source: API Documentation - Bullhorn API Support Forums

Can I retrieve candidate information using the Bullhorn API?

• Answer: Yes, you can retrieve candidate information by making a GET request to the /entity/Candidate/{id} endpoint, where {id} is the candidate's unique identifier. You can specify which fields to return using the fields query parameter.
• Source: API Reference - GitHub Pages

Does the Bullhorn API support webhooks for real-time data updates?

• Answer: As of the latest available information, the Bullhorn API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
• Source: API Documentation - Bullhorn API Support Forums

Get Started with Bullhorn API Integration

Knit API offers a convenient solution for quick and seamless integration with Bullhorn API. Our AI-powered integration platform allows you to build any Bullhorn API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. 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 Bullhorn API.‍

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

‍

CharlieHR is a comprehensive human resources software solution tailored specifically for small businesses, aiming to streamline and automate HR tasks with ease. Designed with user-friendliness in mind, CharlieHR offers a suite of features that simplify the management of HR activities such as onboarding new hires, managing time off, performance management, and conducting engagement surveys. The platform also handles perks and benefits, making it a versatile tool for both managers and employees to navigate their HR responsibilities efficiently.

With a focus on small businesses, CharlieHR provides essential tools for tracking time off and sick leave, as well as monitoring employee work schedules. Its secure data storage and intuitive interface allow users to view, action, and report on various HR aspects effortlessly. Trusted by over 7000 companies, CharlieHR is renowned for its ability to empower teams to manage their own HR activities, reducing the need for a large HR department and enabling businesses to build high-performing teams. For those looking to integrate CharlieHR into their existing systems, the CharlieHR API offers seamless integration capabilities, enhancing the software's functionality and adaptability.

Key highlights of CharlieHR APIs

‍

Core Functionalities:

• Employee Management: Access and manage detailed information about team members, including personal details, employment history, and contact information.
• Time Off Management: Retrieve and handle data related to employee leave requests, balances, and histories.
• Company and Department Data: Obtain information about the organization, its departments, and office locations.

Integration Use Cases:

• Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems.
• Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
• Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.

Supported Protocols:

• RESTful API: The CharlieHR API follows REST principles, facilitating straightforward HTTP requests and responses.

Authentication Mechanisms:

• API Key Authentication: Secure access is granted through API keys, which can be generated within the CharlieHR platform. CharlieHR Help Center

Rate Limiting Policies:

• Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

‍

CharlieHR API Endpoints

‍

Bank Accounts

• GET https://charliehr.com/api/v1/bank_accounts : Get Bank Account Information for Team Members
• GET https://charliehr.com/api/v1/bank_accounts/:team_member_id : Retrieve Bank Account Details

Company

• GET https://charliehr.com/api/v1/company : Company Show
• GET https://charliehr.com/api/v1/offices : List Company Offices
• GET https://charliehr.com/api/v1/offices/:id : Show Office Details
• GET https://charliehr.com/api/v1/teams : List All Teams for Authenticated Company
• GET https://charliehr.com/api/v1/teams/:id : Get Team Details

Leave Management

• GET https://charliehr.com/api/v1/leave_allowances : Leave Allowances Index
• GET https://charliehr.com/api/v1/leave_requests : Leave Requests Index
• GET https://charliehr.com/api/v1/leave_requests/:id : Leave Requests Show
• GET https://charliehr.com/api/v1/team_members/:id/leave_allowance : Team Members Leave Allowance
• GET https://charliehr.com/api/v1/team_members/:id/leave_requests : Team Members Leave Requests

Salaries

• GET https://charliehr.com/api/v1/salaries : Get Salary Details

Team Members

• GET https://charliehr.com/api/v1/team_members : Get Team Members
• GET https://charliehr.com/api/v1/team_members/:id : Get Team Member Details
• GET https://charliehr.com/api/v1/team_members/:id/notes : Get Team Member Notes

Notes

• GET https://charliehr.com/api/v1/team_member_note_types : Team Member Note Types Index‍
• GET https://charliehr.com/api/v1/team_member_note_types/:id : Show Team Member Note Type

CharlieHR API FAQs

How do I generate API keys in CharlieHR?

• Answer: To generate API keys in CharlieHR:some text
  1. Log in to your CharlieHR account as an Admin or Super Admin.
  2. Expand the Company section from the side navigation.
  3. Click on Integrations.
  4. Navigate to the API Access tab.
  5. Follow the instructions to generate the keys in the Your API Keys section.
  6. You will be provided with a Client ID and a Client Secret. Copy these credentials and store them securely, as they will only be displayed once.
• Source: Integrate CharlieHR with selected Apps

What authentication method does the CharlieHR API use?

• Answer: The CharlieHR API uses OAuth 2.0 for authentication. After generating your Client ID and Client Secret, you can obtain an access token by following the OAuth 2.0 flow. This token must be included in the Authorization header of your API requests.
• Source: Integrate CharlieHR with selected Apps

Are there rate limits for the CharlieHR API?

• Answer: The official documentation does not specify explicit rate limits for the CharlieHR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
• Source: CharlieHR API - Developer docs, APIs, SDKs, and auth.

Can I retrieve employee data using the CharlieHR API?

• Answer: Yes, you can retrieve employee data using the CharlieHR API. For example, to list all team members, you can make a GET request to the /team_members endpoint.
• Source: API Documentation - CharlieHR

Does the CharlieHR API support webhooks for real-time data updates?

• Answer: As of the latest available information, the CharlieHR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
• Source: CharlieHR API - Developer docs, APIs, SDKs, and auth.

‍

Get Started with CharlieHR API Integration

Knit API offers a convenient solution for quick and seamless integration with CharlieHR API. Our AI-powered integration platform allows you to build any CharlieHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to CharlieHR API.‍

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

‍

Factorial HR is a robust cloud-based human resources management software designed to streamline and automate a wide array of HR processes for businesses. Tailored to meet the needs of companies of all sizes, from small startups to large enterprises, Factorial HR offers a user-friendly platform that simplifies the complexities of human resources management. By centralizing employee information and automating routine tasks, it empowers HR professionals to focus on strategic initiatives that drive organizational growth.

At its core, Factorial HR excels in employee management by consolidating employee data, tracking attendance, and monitoring work hours. It also automates payroll processes, ensuring accurate and timely salary payments while managing deductions. The software facilitates seamless time-off and leave management, performance evaluations, recruitment, and onboarding. Additionally, Factorial HR aids businesses in maintaining compliance with labor laws through comprehensive reporting and documentation capabilities. With its extensive features, Factorial HR is an indispensable tool for businesses seeking to enhance their HR operations and employee experience.

Key highlights of Factorial HR APIs

Core Functionalities:

• Employee Management: Access and manage detailed information about employees, including personal details, employment history, and contact information.
• Time Off Management: Retrieve and handle data related to employee leave requests, balances, and histories.
• Document Management: Create, retrieve, and manage documents associated with employees and the organization.
• Job Catalog: Manage job titles, roles, and levels within the organization.

Integration Use Cases:

• Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems.
• Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
• Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.

Supported Protocols:

• RESTful API: The Factorial HR API follows REST principles, facilitating straightforward HTTP requests and responses.

Authentication Mechanisms:

• API Keys: Suitable for internal company developments, API keys provide a straightforward method to start making requests to the public API.
• OAuth 2.0: Required for marketplace integrations, OAuth 2.0 allows making requests on behalf of a user or a company, providing a secure channel for token exchange.

Rate Limiting Policies:

• Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

For comprehensive information and to get started with the Factorial HR API, refer to their official API documentation.

Factorial HR API Endpoints

Attendance

• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/break_configurations : Create Break Configuration
• PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/break_configurations/{id} : Update Break Configuration
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/estimated_times : Get Estimated Attendance Times for Employees
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/open_shifts : Retrieve Current Open Shifts for Specified Employees
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests : Get Overtime Requests
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests/approve : Approve Overtime Request
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests/reject : Reject Overtime Request
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests/{id} : Get Overtime Request Details
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts : Get All Shifts
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/autofill : Autofill Employee Shifts
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/break_end : End Break in Open Shift
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/break_start : Start Break in Open Shift
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/clock_in : Clock In a Shift
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/clock_out : Clock Out Shift
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/toggle_clock : Toggle Shift Clock In/Out
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/{id} : Get Shift Details
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/worked_times : Get Worked Times

Companies

• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/companies/legal_entities : Get Legal Entities
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/companies/legal_entities/{id} : Get Legal Entity Details

Documents

• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents : Create Document
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents/move_to_trash_bin : Move Documents to Trash Bin
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents/restore_from_trash_bin : Restore Documents from Trash Bin
• PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents/{id} : Update Document
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/download_urls/bulk_create : Generate Temporal URLs for Document Downloads
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/folders : Get All Document Folders
• PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/folders/{id} : Update Folder

Employee Updates

• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/absences : Retrieve Absence Employee Updates
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/contract_changes : Retrieve Employee Contract Change Updates
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/contract_changes/{id} : Retrieve Employee Contract Change Details
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/summaries : Retrieve Employee Updates Summaries
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/summaries/{id} : Retrieve Employee Updates Summary
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/terminations : Retrieve Termination Employee Updates

Employees

• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employees/employees : Get Employee Information

Time Off

• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves : Create a Leave
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves/approve : Approve Employee Time-off Requests
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves/reject : Reject Employee Time-off Requests
• PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves/{id} : Update Leave Details

Factorial API FAQs

How can I obtain an API key for the Factorial API?

• Answer: Administrators can generate an API key by navigating to the Factorial platform's left sidebar, clicking on "Configuration," selecting the "API" option, and then creating a new API key.
  FactorialHR API Documentation

Can I customize the permissions of the API key in Factorial?

• Answer: No, the API key provides access to all information within the platform and cannot be customized. For more granular access control, consider using OAuth 2.0 to access specific data.
  FactorialHR API Documentation

Does the API key expire?

• Answer: No, the API key does not expire.
  FactorialHR API Documentation

What are the rate limits for the Factorial API?

• Answer: The Factorial API enforces rate limits to ensure fair usage:some text
  • POST requests on /api/v2 endpoints: Limited to 200 requests per minute.
  • POST requests on /api/v1 endpoints: Limited to 100 requests per minute.
    FactorialHR API Documentation

How can I access employee job titles using the Factorial API?

• Answer: Employee job titles are available through the "Contract versions" endpoint. Since each employee can have multiple contract versions, it's essential to retrieve the latest contract version to obtain the current job title.
  FactorialHR API Documentation

Get Started with Factorial API Integration

Knit API offers a convenient solution for quick and seamless integration with Factorial API. Our AI-powered integration platform allows you to build any Factorial API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Factorial API.‍

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

Employment Hero is a comprehensive cloud-based human resources software solution designed to cater to the needs of small and medium-sized businesses. As an all-in-one platform, it centralizes a variety of HR functions, including hiring, HR management, payroll, and employee engagement, making it an essential tool for businesses looking to streamline their HR processes. The software is highly customizable, allowing organizations to create an integrated Human Resource Information System (HRIS) and payroll system that aligns with their specific requirements. This flexibility ensures that businesses can efficiently manage their workforce while focusing on growth and productivity.

One of the standout features of Employment Hero is its ability to manage the entire employee lifecycle. From recruitment and onboarding to payroll, time and attendance, and people management, the platform offers a suite of modules designed to simplify HR tasks. Additionally, Employment Hero can integrate seamlessly with other HR and payroll software, facilitating the handling of employee data such as new hires, salary adjustments, and benefit deductions. This integration capability, particularly through the Employment Hero API, is crucial for businesses aiming to consolidate their HR operations into a single, cohesive system, thereby enhancing efficiency and reducing administrative burdens.

Key highlights of Employment Hero APIs

Employment Hero offers a suite of APIs designed to facilitate seamless integration with its HR and payroll platforms. These APIs enable developers to automate processes, manage employee data, and integrate various HR functionalities into their applications. Below is an overview of the available APIs, their functionalities, authentication methods, and rate limits.

Available APIs and Functionalities:

1. HRIS API:
   • Functionality: Provides access to core HR data, including employee records, organizational information, and related HR functionalities.
   • Use Cases: Automating employee onboarding, updating employee details, and retrieving organizational data.
   • Documentation: Employment Hero API - Australia
2. Payroll API:
   • Functionality: Offers endpoints to manage payroll operations, such as processing payroll, managing deductions, and generating payslips.
   • Use Cases: Automating payroll calculations, integrating with accounting systems, and retrieving payroll reports.
   • Documentation: Employment Hero Payroll API Reference - KeyPay
3. Careers Page API:
   • Functionality: Allows integration of Employment Hero's careers page with an organization's website, ensuring job listings are synchronized.
   • Use Cases: Displaying current job openings on a company's website and automating job posting updates.
   • Documentation: API Reference 1 - Australia

Authentication Methods:

• OAuth 2.0:
  • Employment Hero's APIs primarily use OAuth 2.0 for secure authentication. Developers must register their applications through the Employment Hero Developer Portal to obtain client credentials (Client ID and Client Secret). The authentication flow involves obtaining an access token, which is then used to authorize API requests.
  • Steps:
    1. Register your application in the Developer Portal.
    2. Obtain client credentials.
    3. Authorize the application to receive an authorization code.
    4. Exchange the authorization code for an access token.
    5. Use the access token to authenticate API requests.
  • Reference: API Reference - Australia
• API Key Authentication:
  • Some APIs, like the Careers Page API, utilize API key authentication. Users can generate an API access token within the Employment Hero platform, which is then included in the request headers to authenticate API calls.
  • Reference: API Reference 1 - Australia

Rate Limits:

Employment Hero enforces rate limits to ensure fair usage and maintain system performance. While specific rate limits may vary across different APIs, it's essential to implement error handling for potential rate limiting responses. Developers are advised to consult the respective API documentation or contact Employment Hero support for detailed rate limit information.

Additional Resources:

• Developer Portal: Access to API documentation, client registration, and other developer tools.some text
  • Employment Hero API - Australia
• Payroll API Reference: Detailed documentation for payroll-related API endpoints.some text
  • Employment Hero Payroll API Reference - KeyPay

For comprehensive information and to get started with the Employment Hero API, refer to their official API documentation. Employment Hero Developer

‍

Employment Hero API Endpoints

Organisations

• GET https://api.employmenthero.com/api/v1/organisations : Get Organisations from Employment Hero
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id : Get Organisation Details
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/certifications : Get All Certifications for an Organisation
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/certifications/:id : Get a Certification
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/custom_fields : Get All Custom Fields for an Organisation
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/policies : Get Organisation Policies
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/teams : Get All Teams

Employees

• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees : Get Employees
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:id : Get an Employee
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/bank_accounts : Get Bank Accounts for Employee
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/certifications : Get All Employee Certification Details
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/custom_fields : Get All Employee Custom Fields
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/emergency_contacts : Get Emergency Contact
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/employment_histories : Get Employment History
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/pay_details : Get Employee Pay Details
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/payslips : Get Payslips for Employee
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/superannuation_detail : Get Superannuation Detail
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/tax_declaration : Get Tax Declaration Detail
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/timesheet_entries : Get Timesheet Entries
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/teams/:team_id/employees : Get All Employees of a Team

Leave and Availability

• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/leave_requests : Get Leave Requests
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/leave_requests/:id : Get a Leave Request
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/unavailabilities : List Unavailabilities
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/unavailabilities/:id : Get Unavailability Record by ID

Rostered Shifts

• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/rostered_shifts : List Rostered Shifts
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/rostered_shifts/:id : Get Rostered Shift by ID

Authentication

• GET https://oauth.employmenthero.com/oauth2/authorize : Obtain Access Token
• POST https://oauth.employmenthero.com/oauth2/token : Refresh Access Token

‍

Employment Hero API FAQs

How can I access the Employment Hero API?

• Answer: To access the Employment Hero API, you need to have a Platinum subscription or higher. Once subscribed, you can register your application through the Employment Hero Developer Portal to obtain client credentials, including a Client ID and Client Secret. These credentials are necessary for authenticating your API requests using the OAuth 2.0 protocol.
• Source: API Reference - Australia

What authentication method does the Employment Hero API use?

• Answer: The Employment Hero API utilizes the OAuth 2.0 protocol for secure authentication. After registering your application and obtaining client credentials, you will perform an authorization flow to receive an access token. This token must be included in the Authorization header of your API requests.
• Source: API Reference - Australia

Are there rate limits for the Employment Hero API?

• Answer: Yes, Employment Hero enforces rate limits to ensure fair usage and maintain system performance. While specific rate limits are not publicly detailed, it's recommended to implement error handling for potential rate limiting responses and to contact Employment Hero support for detailed rate limit information.
• Source: Employment Hero API - Australia

Can I retrieve employee data using the Employment Hero API?

• Answer: Yes, the Employment Hero API provides endpoints to retrieve employee data. For example, you can use the /v1/employees endpoint to fetch a list of employees. Ensure that your application has the necessary scopes and permissions to access this data.
• Source: API Reference - Australia

Does the Employment Hero API support webhooks for real-time data updates?

• Answer: As of the latest available information, the Employment Hero API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
• Source: Employment Hero API - Australia

Get Started with Employment Hero API Integration

Knit API offers a convenient solution for quick and seamless integration with Employment Hero API. Our AI-powered integration platform allows you to build any Employment Hero API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Employment Hero API.‍

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

CyberArk software is a leading cybersecurity solution specializing in identity security and privileged access management (PAM). It plays a crucial role in protecting organizations from cyber threats by securing privileged accounts, credentials, and secrets. As cyber threats continue to evolve, CyberArk's robust security measures ensure that sensitive data and critical infrastructure remain safeguarded. Its comprehensive approach to identity security makes it an essential tool for businesses across various industries, aiming to protect their most valuable assets.

One of the key features of CyberArk is its ability to integrate seamlessly with existing IT environments through its API. The CyberArk API facilitates smooth integration, enabling organizations to enhance their security posture without disrupting their current operations. By leveraging the CyberArk API, businesses can automate security processes, streamline identity management, and ensure compliance with industry regulations. This integration capability not only strengthens security but also optimizes operational efficiency, making CyberArk a preferred choice for enterprises seeking advanced cybersecurity solutions.

Key highlights of Cyberark APIs

The CyberArk API suite provides powerful tools to integrate and automate privileged access management (PAM) functionalities. Below are the key highlights of the CyberArk APIs:

Core Functionalities:

• Account Management: Create, retrieve, update, and delete privileged accounts to ensure efficient and secure management of credentials.
• User Management: Manage users, roles, and permissions to enforce strict access control policies.
• Session Management: Initiate, monitor, and terminate privileged sessions with support for session recording for auditing purposes.
• Policy Management: Define, update, and apply security policies for password rotation, access controls, and compliance requirements.

Integration Use Cases:

• Automated Credential Rotation: Enable seamless credential updates for critical systems as per security policies.
• Incident Response Automation: Integrate with SIEM tools to automate detection and response to security events.
• Compliance Audits: Extract detailed logs and session recordings to meet regulatory requirements.

Supported Protocols:

• RESTful API: CyberArk APIs are REST-compliant, using standard HTTP methods for resource interaction.

Authentication Mechanisms:

• Session Token Authentication: Secure API access by using session tokens obtained via the login endpoint.
• OAuth 2.0: Where supported, OAuth 2.0 can be used for enhanced security in integrations.

Rate Limiting Policies:

• Call Limits: Best practices include limiting excessive API calls and handling 429 (Too Many Requests) responses effectively.

For comprehensive information, refer to the official CyberArk API documentation.

‍

Cyberark API Endpoints

CDirectoryService

• post https://{tenant_url}/CDirectoryService/ChangeUser : Update Base Profile Identity API
• post https://{tenant_url}/CDirectoryService/ChangeUserState : Change User State - Identity API
• post https://{tenant_url}/CDirectoryService/ExemptUserFromMfa : Exempt a user from MFA - Identity API Reference
• post https://{tenant_url}/CDirectoryService/GetTechSupportUser : Fetch Technical Support User Identity API
• post https://{tenant_url}/CDirectoryService/GetUser : Get User Details - Identity API
• post https://{tenant_url}/CDirectoryService/GetUserAttributes : Get User Attributes - Identity API
• post https://{tenant_url}/CDirectoryService/GetUserByName : Get User Details by Name - Identity API
• post https://{tenant_url}/CDirectoryService/GetUsers : Get Users Details - Identity API
• post https://{tenant_url}/CDirectoryService/GetUsersFromCsvFile : Start Bulk User Import in CyberArk Identity Cloud Directory
• post https://{tenant_url}/CDirectoryService/SetUserPicture : Set User's Picture via Identity API
• post https://{tenant_url}/CDirectoryService/SetUserState : Set User State in CyberArk Identity
• post https://{tenant_url}/CDirectoryService/SubmitUploadedFile : Advance Bulk User Import - Identity API

Core

• post https://{tenant_url}/Core/GetUserSettings : Get User Settings - Identity API Reference

ExtData

• post https://{tenant_url}/ExtData/GetColumns : Get Additional Attributes for CyberArk Identity User
• post https://{tenant_url}/ExtData/GetSchema : Get Schema - Identity API Reference
• post https://{tenant_url}/ExtData/SetColumns : Set Additional Attributes for CyberArk Identity User
• post https://{tenant_url}/ExtData/UpdateSchema : Add Additional Attributes to Tenant Schema

Org

• post https://{tenant_url}/Org/ChangeMemberShip : Update Organization Membership
• post https://{tenant_url}/Org/Create : Create Organization Identity API
• post https://{tenant_url}/Org/Delete : Delete Organization - Identity API
• post https://{tenant_url}/Org/Get : Get Organization Details - Identity API
• post https://{tenant_url}/Org/GetAdministrators : Get Administrators - Identity API Reference
• post https://{tenant_url}/Org/GetPermission : Get Administrative Rights - Identity API
• post https://{tenant_url}/Org/GetRoles : Get Organization Roles - Identity API
• post https://{tenant_url}/Org/ListAll : Get All Organizations - Identity API
• post https://{tenant_url}/Org/Update : Update Organization Identity API
• post https://{tenant_url}/Org/UpdateAdministrators : Update Administrators for Organization
• post https://{tenant_url}/Org/UpdatePermission : Update Administrative Rights - Identity API

User

• post https://{tenant_url}/User/UpdateProfile : Update User Profile - Identity API

UserMgmt

• post https://{tenant_url}/UserMgmt/ChangeUserAttributes : Update AD User Attributes
• post https://{tenant_url}/UserMgmt/GetUserAttributes : Fetch attributes for a specified user
• post https://{tenant_url}/UserMgmt/GetUserHierarchy : Get User Hierarchy - Identity API
• post https://{tenant_url}/UserMgmt/GetUserInfo : Get User Information - Identity API
• post https://{tenant_url}/UserMgmt/GetUserRiskLevel : Get Risk Level for a Specified User
• post https://{tenant_url}/UserMgmt/GetUsersRolesAndAdministrativeRights : Get User Roles and Administrative Rights
• post https://{tenant_url}/UserMgmt/InviteUsers : Invite Cloud Users - Identity API
• post https://{tenant_url}/UserMgmt/IsUserCloudLocked : Check if User is Locked - Identity API
• post https://{tenant_url}/UserMgmt/IsUserLockedOutByPolicy : Check if user is locked out by policy
• post https://{tenant_url}/UserMgmt/RemoveUsers : Delete Users - Identity API
• post https://{tenant_url}/UserMgmt/SendLoginEmails : Send Invitation Email - Identity API
• post https://{tenant_url}/UserMgmt/SendSmsInvite : Send Invitation SMS - Identity API
• post https://{tenant_url}/UserMgmt/SetCloudLock : Disable or Enable a User Account

SCIM

• get https://{tenant_url}/scim/Groups : Query Groups Identity API
• delete https://{tenant_url}/scim/Groups/{id} : Delete Group Identity API
• post https://{tenant_url}/scim/Users : Create User - Identity API
• put https://{tenant_url}/scim/Users/{id} : Update User Identity API

‍

CyberArk API FAQs

How do I authenticate with the CyberArk REST API?

• Answer: To authenticate with the CyberArk REST API, you need to obtain a session token. This involves sending a POST request to the /PasswordVault/API/Auth/CyberArk/Logon endpoint with your credentials. The response will include a session token, which must be included in the Authorization header of subsequent API requests.
• Source: Authentication - CyberArk Docs

What are the rate limits for the CyberArk REST API?

• Answer: CyberArk's REST APIs are designed to be stable and predictable. While specific rate limits are not explicitly documented, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
• Source: REST APIs - CyberArk Docs

Can I retrieve account information using the CyberArk REST API?

• Answer: Yes, you can retrieve account information using the CyberArk REST API. For example, to list all accounts, you can make a GET request to the /PasswordVault/API/Accounts endpoint.
• Source: Accounts - CyberArk Docs

Does the CyberArk REST API support webhooks for real-time data updates?

• Answer: As of the latest available information, CyberArk's REST API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
• Source: REST APIs - CyberArk Docs

Are there official SDKs or client libraries for the CyberArk REST API?

• Answer: CyberArk provides a RESTful API that can be invoked by any RESTful client for various programming and scripting environments, including Java, C#, Perl, PHP, Python, and Ruby.
• Source: REST APIs - CyberArk Docs

Get Started with CyberArk API Integration

Knit API offers a convenient solution for quick and seamless integration with CyberArk API. Our AI-powered integration platform allows you to build any CyberArk API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to CyberArk API.‍

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

Close CRM is a robust customer relationship management software tailored for startups and small to medium-sized businesses (SMBs) aiming to enhance their sales processes. Designed with a focus on sales efficiency, Close CRM equips sales teams with a suite of tools to streamline activities and boost performance. Key features include advanced emailing capabilities, a power dialer, email automation, and integrated outbound sales tools, all of which contribute to a more efficient sales workflow. By automating and optimizing sales processes, Close CRM helps businesses convert leads into revenue, making it an essential tool for sales-driven organizations.

In addition to its core functionalities, Close CRM offers comprehensive reporting and management features that provide valuable insights into sales activities and outcomes. This enables sales professionals to make informed decisions and refine their strategies. For businesses looking to integrate Close CRM with other systems, the Close API offers seamless integration capabilities, allowing for enhanced customization and functionality. The Close API is a critical component for businesses seeking to leverage the full potential of Close CRM in their sales operations.

Key highlights of Close CRM APIs

The Close API provides developers with a comprehensive suite of tools to integrate and automate sales processes within their applications. Below are the key highlights of the Close API:

Core Functionalities:

• Lead Management: Create, retrieve, update, and delete leads, enabling seamless integration with your sales pipeline.
  
• Activity Tracking: Log and manage various activities such as calls, emails, notes, and meetings associated with leads.
  
• Custom Fields: Define and utilize custom fields to store additional information on leads, contacts, opportunities, and activities, allowing for tailored data management.
  
• Webhooks: Set up webhooks to receive real-time notifications about specific events, facilitating timely data synchronization.
  

Integration Use Cases:

• CRM Synchronization: Integrate Close with other CRM systems to ensure consistent and up-to-date customer information across platforms.
• Automated Workflows: Develop automated workflows that trigger actions based on specific events, such as sending follow-up emails after a call is logged.
• Custom Reporting: Extract and analyze sales data to generate custom reports that provide insights into sales performance and trends.

Supported Protocols:

• RESTful API: The Close API adheres to REST conventions, utilizing standard HTTP methods and predictable URL structures for resource manipulation.
  

Authentication Mechanisms:

• API Key Authentication: Suitable for internal scripts and simple integrations, API keys are used for authentication via HTTP Basic Authentication.
  
• OAuth 2.0: For public applications, OAuth 2.0 is employed to grant secure access to the API on behalf of users.
  

Rate Limiting Policies:

• Per-Endpoint Group Limits: The API enforces rate limits based on endpoint groups, allowing higher limits for lightweight requests compared to more resource-intensive ones.
  
• Organization-Level Limits: Rate limits are applied at the organization level across all users' API keys, with additional per-API key limits to prevent individual integrations from affecting others.
  

For detailed information and to begin integrating with the Close API, refer to their official API documentation. Close Developer

Close CRM API Endpoints

Activity

• DELETE https://api.close.com/api/v1/activity/call/{id}/ : Delete a Call Activity
• POST https://api.close.com/api/v1/activity/custom/ : Create a new Custom Activity instance
• DELETE https://api.close.com/api/v1/activity/custom/{id}/ : Delete a Custom Activity Instance
• POST https://api.close.com/api/v1/activity/email/ : Create an Email Activity
• DELETE https://api.close.com/api/v1/activity/email/{id}/ : Delete an Email Activity
• DELETE https://api.close.com/api/v1/activity/emailthread/{id}/ : Delete an EmailThread Activity
• DELETE https://api.close.com/api/v1/activity/meeting/{id}/ : Delete a Meeting Activity
• POST https://api.close.com/api/v1/activity/meeting/{id}/integration/ : Create or Update Third Party Meeting Integration
• POST https://api.close.com/api/v1/activity/note/ : Create a Note Activity
• DELETE https://api.close.com/api/v1/activity/note/{id}/ : Delete a Note Activity
• POST https://api.close.com/api/v1/activity/sms/ : Create an SMS Activity
• DELETE https://api.close.com/api/v1/activity/sms/{id}/ : Delete an SMS activity
• POST https://api.close.com/api/v1/activity/status_change/lead/ : Create a new LeadStatusChange activity
• DELETE https://api.close.com/api/v1/activity/status_change/lead/{id}/ : Delete a single LeadStatusChange activity
• POST https://api.close.com/api/v1/activity/status_change/opportunity/ : Create a new OpportunityStatusChange activity
• DELETE https://api.close.com/api/v1/activity/status_change/opportunity/{id}/ : Delete a Single OpportunityStatusChange Activity
• DELETE https://api.close.com/api/v1/activity/task_completed/{id}/ : Delete a TaskCompleted Activity

Comment

• POST https://api.close.com/api/v1/comment/ : Create a Comment

Contact

• POST https://api.close.com/api/v1/contact/ : Create a New Contact
• DELETE https://api.close.com/api/v1/contact/{id}/ : Delete a Contact

Custom Activity

• POST https://api.close.com/api/v1/custom_activity/ : Create New Custom Activity Type
• DELETE https://api.close.com/api/v1/custom_activity/{id}/ : Delete a Custom Activity Type

Custom Field

• POST https://api.close.com/api/v1/custom_field/activity/ : Create a new Activity Custom Field
• DELETE https://api.close.com/api/v1/custom_field/activity/{custom_field_id}/ : Delete an Activity Custom Field
• POST https://api.close.com/api/v1/custom_field/contact/ : Create a new Contact Custom Field
• DELETE https://api.close.com/api/v1/custom_field/contact/{custom_field_id}/ : Delete a Contact Custom Field
• POST https://api.close.com/api/v1/custom_field/custom_object_type/ : Create a new Custom Object Custom Field
• DELETE https://api.close.com/api/v1/custom_field/custom_object_type/{custom_field_id}/ : Delete a Custom Object Custom Field
• POST https://api.close.com/api/v1/custom_field/lead/ : Create a new Lead Custom Field
• DELETE https://api.close.com/api/v1/custom_field/lead/{custom_field_id}/ : Delete a Lead Custom Field
• POST https://api.close.com/api/v1/custom_field/opportunity/ : Create a new Opportunity Custom Field
• DELETE https://api.close.com/api/v1/custom_field/opportunity/{custom_field_id}/ : Delete an Opportunity Custom Field
• POST https://api.close.com/api/v1/custom_field/shared/ : Create a new Shared Custom Field
• DELETE https://api.close.com/api/v1/custom_field/shared/{custom_field_id}/ : Delete a Shared Custom Field
• DELETE https://api.close.com/api/v1/custom_field/shared/{custom_field_id}/association/{object_type}/ : Disassociate a Shared Custom Field from an Object
• POST https://api.close.com/api/v1/custom_field/shared/{shared_custom_field_id}/association/ : Associate a Shared Custom Field with an Object Type

Custom Object

• POST https://api.close.com/api/v1/custom_object/ : Create a new Custom Object instance
• DELETE https://api.close.com/api/v1/custom_object/{id}/ : Delete a Custom Object Instance

Custom Object Type

• POST https://api.close.com/api/v1/custom_object_type/ : Create New Custom Object Type
• DELETE https://api.close.com/api/v1/custom_object_type/{id}/ : Delete a Custom Object Type

Email Template

• POST https://api.close.com/api/v1/email_template/ : Create an Email Template
• DELETE https://api.close.com/api/v1/email_template/{id}/ : Delete an Email Template

Export

• POST https://api.close.com/api/v1/export/lead/ : Export Leads, Opportunities, or Contacts

Group

• POST https://api.close.com/api/v1/group/ : Create a Group
• DELETE https://api.close.com/api/v1/group/{group_id}/ : Delete a Group
• POST https://api.close.com/api/v1/group/{group_id}/member/ : Add a User to a Group

Integration Link

• POST https://api.close.com/api/v1/integration_link/ : Create an Integration Link
• DELETE https://api.close.com/api/v1/integration_link/{id}/ : Delete an Integration Link

Lead

• POST https://api.close.com/api/v1/lead/ : Create a New Lead
• DELETE https://api.close.com/api/v1/lead/{id}/ : Delete a Lead

Membership

• POST https://api.close.com/api/v1/membership/ : Create or Activate Membership

Opportunity

• POST https://api.close.com/api/v1/opportunity/ : Create an Opportunity
• DELETE https://api.close.com/api/v1/opportunity/{id}/ : Delete an Opportunity

Phone Number

• DELETE https://api.close.com/api/v1/phone_number/{id}/ : Delete a Phone Number

Pipeline

• POST https://api.close.com/api/v1/pipeline/ : Create a Pipeline
• DELETE https://api.close.com/api/v1/pipeline/{pipeline_id}/ : Delete a Pipeline

Role

• POST https://api.close.com/api/v1/role/ : Create a New Role
• DELETE https://api.close.com/api/v1/role/{role_id}/ : Delete a Role

Saved Search

• POST https://api.close.com/api/v1/saved_search/ : Create a Contact Smart View
• DELETE https://api.close.com/api/v1/saved_search/{id}/ : Delete a Smart View

Scheduling Link

• POST https://api.close.com/api/v1/scheduling_link/ : Create a User Scheduling Link
• POST https://api.close.com/api/v1/scheduling_link/integration/ : Create or Update a User Scheduling Link via OAuth Integration
• DELETE https://api.close.com/api/v1/scheduling_link/integration/{source_id}/ : Delete User Scheduling Link by Source ID via OAuth
• DELETE https://api.close.com/api/v1/scheduling_link/{id}/ : Delete a User Scheduling Link

Send As

• DELETE https://api.close.com/api/v1/send_as/ : Delete a Send As Association by Allowed User
• POST https://api.close.com/api/v1/send_as/bulk/ : Edit Send As Associations in Bulk
• DELETE https://api.close.com/api/v1/send_as/{id}/ : Delete a Send As Association by ID

Sequence

• POST https://api.close.com/api/v1/sequence/ : Create a Sequence
• DELETE https://api.close.com/api/v1/sequence/{id}/ : Delete a Sequence

Shared Scheduling Link

• POST https://api.close.com/api/v1/shared_scheduling_link/ : Create a Shared Scheduling Link
• DELETE https://api.close.com/api/v1/shared_scheduling_link/{id}/ : Delete a Shared Scheduling Link

SMS Template

• POST https://api.close.com/api/v1/sms_template/ : Create an SMS Template
• DELETE https://api.close.com/api/v1/sms_template/{id}/ : Delete an SMS Template

Status

• POST https://api.close.com/api/v1/status/lead/ : Create a New Status for Leads
• DELETE https://api.close.com/api/v1/status/lead/{status_id}/ : Delete a Lead Status
• POST https://api.close.com/api/v1/status/opportunity/ : Create Opportunity Status
• DELETE https://api.close.com/api/v1/status/opportunity/{status_id}/ : Delete an Opportunity Status

Task

• PUT https://api.close.com/api/v1/task/ : Bulk Update Tasks
• DELETE https://api.close.com/api/v1/task/{id}/ : Delete a Task

Webhook

• POST https://api.close.com/api/v1/webhook/ : Create new Webhook subscription
• DELETE https://api.close.com/api/v1/webhook/{id}/ : Delete Webhook Subscription

‍

Close API FAQs

How do I authenticate with the Close API?

• Answer: The Close API supports two authentication methods:some text
  • API Key: Suitable for scripts and internal integrations. Generate an API key in your Close account settings and include it in the Authorization header of your HTTP requests, formatted as Basic {Base64EncodedAPIKey:}.
  • OAuth 2.0: Recommended for public applications. Register your application in the Close Developer settings to obtain a client ID and secret. Follow the OAuth 2.0 flow to obtain an access token, which should be included in the Authorization header as Bearer {AccessToken}.
• Source: Authentication with API keys - Close API Documentation

What are the rate limits for the Close API?

• Answer: Close enforces rate limits to ensure fair usage. The default limit is 60 requests per minute per organization. Exceeding this limit will result in a 429 Too Many Requests response. It's advisable to implement exponential backoff in your application to handle rate limiting gracefully.
• Source: Rate Limits - Close API Documentation

Can I retrieve lead information using the Close API?

• Answer: Yes, you can retrieve lead information by making a GET request to the /lead/ endpoint. This will return a list of leads and their details. You can also filter leads using query parameters to narrow down the results.
• Source: Leads - Close API Documentation

Does the Close API support webhooks for real-time data updates?

• Answer: Yes, Close supports webhooks, allowing you to receive real-time notifications for specific events, such as when a lead is updated or a new opportunity is created. You can configure webhook subscriptions to specify which events you want to receive notifications for.
• Source: Webhooks - Close API Documentation

Are there official API clients or SDKs for the Close API?

• Answer: Yes, Close provides official API clients for various programming languages to facilitate integration:some text
  • Python: An officially maintained wrapper for Python developers.
  • Node.js: An officially maintained wrapper for Node.js developers.
  • Ruby, PHP, C#, Elixir, Go: Community-contributed clients are available for these languages.
• Source: API Clients - Close API Documentation

Get Started with Close API Integration

Knit API offers a convenient solution for quick and seamless integration with Close API. Our AI-powered integration platform allows you to build any Close API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Close API.

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

Breezy software is a cutting-edge recruitment and applicant tracking system designed to revolutionize the hiring process for organizations. By automating essential tasks such as pre-screening candidates, sending emails, scheduling interviews, and collecting feedback, Breezy empowers human resources and recruitment teams to focus on strategic decision-making rather than administrative burdens. This innovative platform serves as a comprehensive solution for streamlining hiring workflows, ensuring that companies can efficiently manage their talent acquisition efforts.

One of the standout features of Breezy is its robust API integration capabilities. The Breezy API allows seamless connectivity with various third-party applications, enabling organizations to customize and enhance their recruitment processes. By leveraging the Breezy API, businesses can integrate their existing HR tools and systems, ensuring a cohesive and efficient hiring ecosystem. This flexibility not only optimizes the recruitment process but also provides a scalable solution that can adapt to the evolving needs of any organization.

Key highlights of Breezy APIs

• 1. Streamlined Recruitment Processes:
  • Automates routine tasks, making recruitment more efficient.
• 2. Custom Integrations:
  • Allows building custom integrations tailored to specific needs.
• 3. Real-time Updates:
  • Provides real-time updates via webhooks for timely decision-making.
• 4. No-Code Simplicity:
  • Enables integration and automation without extensive coding knowledge.
• 5. Fast Development Speeds:
  • Supports rapid development for quick implementation of new features.
• 6. Hands-On Support:
  • Offers support to help users effectively utilize the API.
• 7. Integration with Multiple Apps:
  • Can integrate with a multitude of other applications, enhancing functionality.
• 8. REST APIs for Recruiting Features:
  • Allows integration of recruiting features like managing candidates, jobs, and interviews.
• 9. Custom Objects and Fields:
  • Users can create custom objects, fields, rules, calculations, and views.
• 10. Unified API for ATS:
  • Connects with various applications through a unified API, aiding in closing deals and retaining customers.
• 11. Automated Workflows:
  • Supports automation of workflows, freeing up time for more critical tasks.

Breezy API Endpoints

Company

• GET https://api.breezy.hr/v3/companies : Retrieve Companies Associated with Authenticated User
• GET https://api.breezy.hr/v3/company/{company_id} : Retrieve Company Information
• GET https://api.breezy.hr/v3/company/{company_id}/custom-attributes/candidate : Retrieve Candidate Specific Custom Attributes
• GET https://api.breezy.hr/v3/company/{company_id}/custom-attributes/position : Retrieve Position Specific Custom Attributes
• GET https://api.breezy.hr/v3/company/{company_id}/questionnaires : Retrieve Company Questionnaires
• GET https://api.breezy.hr/v3/company/{company_id}/template/{template_id} : Retrieve Company Email Templates

Position

• GET https://api.breezy.hr/v3/company/{company_id}/positions : Retrieve All jobs present in the system.
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id} : Retrieve Position Details
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidates : Retrieve Candidates for Given Position
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/custom-fields : Get Position Custom Fields
• PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/custom-fields/{custom_field_id} : Update Position Custom Field
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/stream : Retrieve Last 30 Activity Stream Events for a Position
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/team : Retrieve User Objects of All Position Team Members

Candidate

• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id} : Retrieve Candidate by ID for Given Position
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/assessments : Retrieve Candidate's 3rd Party Assessments
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/background-checks : Retrieve all 3rd party background checks for candidate
• POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/conversation : Add New Conversation Message for Candidate
• PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-attribute : Add Custom Attribute to Candidate
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-fields : Get Candidate Custom Fields
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/documents : Retrieve Candidate Documents by ID for Given Position
• PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/education : Add Education Entry to Candidate
• POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/meta : Retrieve Candidate Meta Data by ID for Given Position
• POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/questionnaire/{candidate_questionnaire_id} : Save Candidate Responses to a Questionnaire
• GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/questionnaires : Retrieve Candidate Questionnaires
• POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/resume : Attach a Resume File to an Existing Candidate
• PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/scorecard : Update Candidate Scorecard for User
• POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/send-questionnaire : Create a New Questionnaire for a Candidate
• PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/stage : Move Candidate to Specified Stage
• POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/stream : Add Note to Candidate's Discussion Stream
• PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/work-history : Add Work History Entry to Candidate
• POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidates/resume : Upload and Parse Resume to Create Candidate

Pipeline

• GET https://api.breezy.hr/v3/company/{company_id}/pipeline/{pipeline_id} : Retrieve Pipeline Stages by Pipeline ID

Questionnaire

• GET https://api.breezy.hr/v3/company/{company_id}/questionnaire/{questionnaire_id} : Retrieve Questionnaire by ID

Authentication

• POST https://api.breezy.hr/v3/signin : Retrieve Access Token
• GET https://api.breezy.hr/v3/signout : Invalidate Access Token

User

• GET https://api.breezy.hr/v3/user : Retrieve User Information
• GET https://api.breezy.hr/v3/user/details : Retrieve User Company Configuration Details

‍

Breezy API FAQs

How do I obtain API credentials for Breezy HR?

• Answer: To obtain API credentials in Breezy HR:some text
  1. Log in to your Breezy HR account.
  2. Click on the gear icon (⚙️) in the left sidebar to access Company Settings.
  3. Navigate to the Integrations section.
  4. Locate the API option and click on Settings.
  5. Here, you can generate and manage your API keys.

What authentication method does the Breezy HR API use?

• Answer: The Breezy HR API utilizes token-based authentication. After generating an API key, include it in the Authorization header of your HTTP requests, formatted as Bearer YOUR_API_KEY.
• Source: Breezy API - Developer docs, APIs, SDKs, and auth.

Are there rate limits for the Breezy HR API?

• Answer: The official documentation does not specify explicit rate limits for the Breezy HR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
• Source: Breezy API - Developer docs, APIs, SDKs, and auth.

Can I retrieve candidate information using the Breezy HR API?

• Answer: Yes, you can retrieve candidate information using the Breezy HR API. For example, to list all candidates for a specific position, make a GET request to the /positions/{position_id}/candidates endpoint.

Does the Breezy HR API support webhooks for real-time data updates?

• Answer: As of the latest available information, Breezy HR does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
• Source: Breezy API - Developer docs, APIs, SDKs, and auth.

Get Started with Breezy API Integration

Knit API offers a convenient solution for quick and seamless integration with Breezy API. Our AI-powered integration platform allows you to build any Breezy API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. 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 Breezy API.‍

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

iCIMS is a leading software company specializing in talent acquisition solutions through its robust platform, the iCIMS Talent Cloud. This comprehensive platform is tailored to assist organizations in attracting, engaging, hiring, and advancing talent, with a strong emphasis on recruitment and internal mobility. By leveraging iCIMS, businesses can streamline their hiring processes, potentially reducing the time-to-fill positions by up to 50%. The software's Applicant Tracking System (ATS) is designed to simplify and accelerate recruitment workflows, enabling HR teams to efficiently manage the complexities of hiring.

Globally trusted by organizations, iCIMS software empowers businesses to build, retain, and scale their workforce effectively. It provides essential tools for talent acquisition and management, ensuring that companies can attract and hire the best talent while optimizing their recruitment strategies. As a vital component of the human resources domain, iCIMS enhances the efficiency of HR operations, making it an indispensable asset for modern businesses seeking to improve their talent acquisition processes.

Key highlights of iCIMS APIs

• Configurable and Flexible Integrations:
  • iCIMS API allows for customizable integrations that can be tailored to meet specific business needs.
• Secure and Reliable:
  • The API ensures secure data transactions and reliable performance.
• Data Import and Export:
  • It supports data imports and exports using flat-file or file-based transfers, facilitating easy data management.
• Native Integrations:
  • iCIMS provides native integrations with various HR systems, enhancing the functionality of the iCIMS Talent Cloud.
• Custom Integrations:
  • The API allows for the creation of custom integrations, enabling businesses to connect iCIMS with third-party tools.
• Streamlined HR Tech Stack:
  • By integrating with iCIMS, businesses can centralize their HR technology, improving efficiency and reducing complexity.
• Robust Recruiting Solutions:
  • Integrations with iCIMS Talent Cloud products help create comprehensive solutions for recruiting and retaining talent.
• Two Main Integration Paths:
  • Businesses can choose between customer-specific integrations or iCIMS-defined integrations, providing flexibility in how integrations are implemented.
• Partner Opportunities:
  • iCIMS offers partnership opportunities for businesses looking to build repeatable integrations, driving mutual business growth.
• Assessment Integrations:
  • iCIMS Assessments integrations allow businesses to leverage a wide range of assessment types, enhancing the recruitment process.

iCIMS API Endpoints

Applicant Workflows

• POST https://api.icims.com/customers/{{customerId}}/applicantworkflows : Create a new application
• GET https://api.icims.com/customers/{{customerId}}/applicantworkflows/{{applicationId}} : Get all interview details for an application
• POST https://api.icims.com/customers/{{customerId}}/search/applicantworkflows : Get all job applications

Jobs

• POST https://api.icims.com/customers/{{customerId}}/jobs : Create job
• GET https://api.icims.com/customers/{{customerId}}/jobs/{{jobId}} : Get recruiters assigned to a job
• POST https://api.icims.com/customers/{{customerId}}/search/jobs : List all jobs

People

• PATCH https://api.icims.com/customers/{{customerId}}/people/{{candidateId}} : Add tag to candidate
• GET https://api.icims.com/customers/{{customerId}}/people/{{candidate_id}}/fields/resume/text : Get all attachments for an application

‍

iCIMS API FAQs

How do I access the iCIMS API documentation?

• Answer: To access the iCIMS API documentation, visit the iCIMS Developer Community. This platform provides comprehensive resources for developers, including API references, integration guides, and best practices.
• Source: iCIMS Developer Community

What authentication methods are supported by the iCIMS API?

• Answer: The iCIMS API supports multiple authentication methods:some text
  • OAuth 2.0: Recommended for secure and scalable integrations.
  • HMAC (Hash-Based Message Authentication Code): Provides an additional layer of security for API requests.
• Source: Connecting and Authentication - iCIMS Developer Resources

Are there rate limits for the iCIMS API?

• Answer: Yes, iCIMS enforces rate limits to ensure fair usage:some text
  • Default Limit: 10,000 API calls per day per customer.
  • Reset Time: Limits reset daily at 12:00 AM UTC.
  • Headers: Each API response includes headers indicating the current rate limit status.
• Source: Connecting and Authentication - iCIMS Developer Resources

Can I retrieve candidate information using the iCIMS API?

• Answer: Yes, you can retrieve candidate information using the iCIMS API. The Profiles API allows access to various profile types, including candidate profiles.
• Source: Profiles API - iCIMS Developer Resources

Does the iCIMS API support webhooks for real-time data updates?

• Answer: As of the latest available information, iCIMS does not natively support webhooks. However, you can use the API to poll for changes or integrate with third-party services that provide webhook functionality to achieve similar outcomes.
• Source: iCIMS Developer Community

‍

Get Started with iCIMS API Integration

Knit API offers a convenient solution for quick and seamless integration with iCIMS API. Our AI-powered integration platform allows you to build any iCIMS API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. 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 iCIMS API.‍

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

‍

Freshteam is a comprehensive HR software solution designed to streamline recruitment, onboarding, and employee management processes. As part of the Freshworks suite, Freshteam offers a user-friendly interface that simplifies the complexities of human resource management, making it an essential tool for businesses of all sizes. By automating repetitive tasks and providing a centralized platform for managing employee data, Freshteam enhances efficiency and productivity within HR departments.

One of the standout features of Freshteam is its robust API integration capabilities. The Freshteams API allows businesses to seamlessly connect Freshteam with other software applications, facilitating data exchange and enhancing workflow automation. This integration capability is crucial for organizations looking to create a cohesive HR ecosystem, enabling them to leverage the full potential of Freshteam alongside their existing tools. By utilizing the Freshteams API, companies can customize their HR processes to better suit their unique needs, ensuring a more tailored and efficient approach to human resource management.

Key highlights of freshteam APIs

• Easy Data Access:
  • Access employee information effortlessly with Freshteam API's streamlined data retrieval capabilities.
• Automation:
  • Enhance efficiency through seamless data synchronization and automated HR processes.
• Custom Integration:
  • Integrate with various platforms using a unified API for multiple integrations, tailored to your business needs.
• Real-Time Sync:
  • Keep your data up-to-date with real-time updates, ensuring accuracy across all systems.
• Developer-Friendly:
  • Benefit from an accessible API design, SDKs, and comprehensive documentation for easy implementation.

Employee Management

• put /api/employees/{id}/send_invite : Send Employee Portal Invitation Email
• get https://<account-name>.freshteam.com/api/employees : List All Employees
• put https://<account-name>.freshteam.com/api/employees/{id} : Update Employee Information
• post https://<account-name>.freshteam.com/api/employee_fields : Create Custom Employee Field
• post https://<account-name>.freshteam.com/api/new_hires : Create a New Hire
• put https://<account-name>.freshteam.com/api/new_hires/{id} : Update New Hire Information

Organizational Structure

• get https://<account-name>.freshteam.com/api/branches : List All Branches
• get https://<account-name>.freshteam.com/api/business_units : List All Business Units
• get https://<account-name>.freshteam.com/api/departments : List All Departments
• get https://<account-name>.freshteam.com/api/sub_departments : List All Sub-Departments
• get https://<account-name>.freshteam.com/api/teams : List All Teams
• get https://<account-name>.freshteam.com/api/roles : List All Roles
• get https://<account-name>.freshteam.com/api/levels : List All Levels

Recruitment

• get https://<account-name>.freshteam.com/api/candidate_source_categories : List All Candidate Source Categories
• post https://<account-name>.freshteam.com/api/candidate_sources : Create Candidate Source
• get https://<account-name>.freshteam.com/api/job_posting_fields : List All Job Posting Fields
• get https://<account-name>.freshteam.com/api/job_postings : List All Job Postings
• get https://<account-name>.freshteam.com/api/job_postings/{id} : Retrieve Job Posting Information
• get https://<account-name>.freshteam.com/api/job_postings/{id}/applicant_fields : List All Applicant Fields
• post https://<account-name>.freshteam.com/api/job_postings/{id}/applicants : Create an Applicant for a Job Posting

Time Off Management

• get https://<account-name>.freshteam.com/api/time_off_types : List All Timeoff Types
• get https://<account-name>.freshteam.com/api/time_offs : List All Timeoffs
• get https://<account-name>.freshteam.com/api/time_offs/{id} : Retrieve Timeoff Information
• put https://<account-name>.freshteam.com/api/time_offs/{id}/approve : Approve a Timeoff Request
• put https://<account-name>.freshteam.com/api/time_offs/{id}/cancel : Cancel a Timeoff Request

User Functions

• get https://<account-name>.freshteam.com/api/user_functions : List all user functions

‍

Freshteam API FAQs

How do I obtain an API key in Freshteam?

• Answer: To obtain your API key in Freshteam:some text
  1. Log in to your Freshteam account.
  2. Click on your profile icon in the top-right corner.
  3. Select API Settings from the dropdown menu.
  4. Your API key will be displayed under Your API Key.
• Source: Freshteam API Documentation

What authentication method does the Freshteam API use?

• Answer: The Freshteam API uses OAuth 2.0 for authentication. You need to obtain an access token by making a call to the Freshteam authentication server and include this token in the Authorization header of your API requests.
• Source: Freshteam API Documentation

Are there rate limits for the Freshteam API?

• Answer: Yes, Freshteam enforces rate limits based on your subscription plan and the number of subscribed employees:some text
  • Free Plan: No API access.
  • Trial Plan: 10 requests per minute.
  • Growth and Pro Plans: Maximum of 50 requests per minute.
  • Enterprise Plan: Maximum of 100 requests per minute.
• Source: Freshteam API Documentation

Can I retrieve employee data using the Freshteam API?

• Answer: Yes, you can retrieve employee data by making a GET request to the /employees endpoint. This will return a list of employees and their details.
• Source: Freshteam API Documentation

Does the Freshteam API support webhooks?

• Answer: Yes, Freshteam supports webhooks, allowing you to receive real-time notifications for specific events, such as when a new employee is added or an employee's information is updated.
• Source: Freshteam Developers

‍

Get Started with Freshteam API Integration

For quick and seamless integration with Freshteam API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Freshteam API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 Freshteam API.‍

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

‍

Greenhouse software is a leading applicant tracking system (ATS) and recruiting platform designed to enhance the recruitment process for organizations of all sizes. By offering a comprehensive suite of tools, Greenhouse streamlines the entire hiring workflow, from sourcing candidates to managing applications and coordinating interviews. This robust software empowers human resources and recruitment teams to collaborate effectively, ensuring a seamless and efficient hiring process. With its focus on data-driven decision-making, Greenhouse provides valuable insights through recruiting metrics, enabling organizations to optimize their recruitment strategies and improve overall hiring outcomes.

A key feature of Greenhouse is its ability to integrate seamlessly with other platforms through the Greenhouse API. This integration capability allows businesses to customize and extend the functionality of the software, ensuring it meets their unique recruitment needs. By leveraging the Greenhouse API, organizations can automate various aspects of the recruitment process, enhance data sharing across systems, and create a more cohesive and efficient hiring ecosystem. As a result, Greenhouse not only simplifies recruitment but also fosters a more strategic approach to talent acquisition.

Key Highlights of Greenhouse APIs

• 1. Easy Data Access:
  • Facilitates seamless data flow into and out of the platform.
• 2. Custom Integration:
  • Allows for tailored integrations to fit specific hiring workflows.
• 3. Real-Time Sync:
  • Typically supports real-time data synchronization.
• 4. Strong Security:
  • Implements security measures to protect data and ensure secure access.
• 5. Scalable:
  • Designed to handle varying loads, suitable for different users and organizations.
• 6. Developer-Friendly:
  • Accessible to developers with documentation and support.
• 7. Global Support:
  • Accommodates international users and functions across regions.
• 8. Error Handling and Logging:
  • Includes features for robust error handling.
• 9. Rate Limiting:
  • Prevents abuse and ensures fair usage.
• 10. Version Control:
  • Manages changes and updates without disrupting existing integrations.
• 11. Data Transformation:
  • Allows manipulation of data formats as needed.
• 12. Webhook Support:
  • Enables real-time notifications and updates.
• 13. Detailed Analytics and Reporting:
  • Provides insights into hiring processes and data usage.
• 14. Sandbox Environment:
  • Allows testing of integrations and features without affecting live data.

Greenhouse API Endpoints

General

• POST https://api.example.com/greenhouse/test : Test Greenhouse API
• POST https://api.example.com/v1/sample : Sample API

Applications

• POST https://api.greenhouse.io/v1/applications/{application_id}/advance : Advance Application
• GET https://harvest.greenhouse.io/v1/applications/{application_id}/offers : List Offers Associated with an Application
• GET https://harvest.greenhouse.io/v1/applications/{application_id}/offers/current_offer : Fetch Current Offer for Application
• GET https://harvest.greenhouse.io/v1/applications/{id} : Retrieve Application by ID
• PATCH https://harvest.greenhouse.io/v1/applications/{id}/convert_prospect : Convert Prospect Application to Candidate
• GET https://harvest.greenhouse.io/v1/applications/{id}/demographics/answers : List Demographic Answers for an Application
• GET https://harvest.greenhouse.io/v1/applications/{id}/eeoc : Retrieve Application EEOC Data
• POST https://harvest.greenhouse.io/v1/applications/{id}/hire : Hire Application
• POST https://harvest.greenhouse.io/v1/applications/{id}/move : Move Application Between Stages
• PATCH https://harvest.greenhouse.io/v1/applications/{id}/offers/current_offer : Update Current Offer on Application
• POST https://harvest.greenhouse.io/v1/applications/{id}/reject : Reject Application
• GET https://harvest.greenhouse.io/v1/applications/{id}/scheduled_interviews : Get Scheduled Interviews for an Application
• GET https://harvest.greenhouse.io/v1/applications/{id}/scorecards : List All Submitted Scorecards for an Application
• POST https://harvest.greenhouse.io/v1/applications/{id}/transfer_to_job : Transfer Application to Different Job Stage
• POST https://harvest.greenhouse.io/v1/applications/{id}/unreject : Unreject Application

Approval Flows

• GET https://harvest.greenhouse.io/v1/approval_flows/{id} : Retrieve Approval Flow
• POST https://harvest.greenhouse.io/v1/approval_flows/{id}/request_approvals : Request Approval Flow Start

Approver Groups

• PUT https://harvest.greenhouse.io/v1/approver_groups/{approver_group_id}/replace_approvers : Replace Approvers in Approver Group

Candidates

• POST https://harvest.greenhouse.io/v1/candidates : Create a New Candidate
• PUT https://harvest.greenhouse.io/v1/candidates/merge : Merge Two Candidates
• DELETE https://harvest.greenhouse.io/v1/candidates/{candidate_id}/educations/{education_id} : Delete Education Record by Candidate and Education ID
• DELETE https://harvest.greenhouse.io/v1/candidates/{candidate_id}/employments/{employment_id} : Delete Employment Record
• PUT https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id} : Apply a Tag to a Candidate
• DELETE https://harvest.greenhouse.io/v1/candidates/{id} : Delete Candidate by ID
• POST https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/emails : Create Candidate Email Note
• POST https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/notes : Create Candidate Note
• PUT https://harvest.greenhouse.io/v1/candidates/{id}/anonymize?fields={field_names} : Anonymize Candidate Data
• POST https://harvest.greenhouse.io/v1/candidates/{id}/attachments : Post Attachment to Candidate Profile
• POST https://harvest.greenhouse.io/v1/candidates/{id}/educations : Create a New Education Record for a Candidate
• POST https://harvest.greenhouse.io/v1/candidates/{id}/employments : Create a New Employment Record
• GET https://harvest.greenhouse.io/v1/candidates/{id}/tags : Retrieve Candidate Tags

Close Reasons

• GET https://harvest.greenhouse.io/v1/close_reasons : List Organization's Close Reasons

Custom Fields

• GET https://harvest.greenhouse.io/v1/custom_field/{id} : Get Custom Field by ID
• DELETE https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options : Destroy Custom Field Options
• POST https://harvest.greenhouse.io/v1/custom_fields : Create Custom Fields in Greenhouse
• GET https://harvest.greenhouse.io/v1/custom_fields/{field_type} : Get Custom Fields
• DELETE https://harvest.greenhouse.io/v1/custom_fields/{id} : Delete Custom Field

Degrees

• GET https://harvest.greenhouse.io/v1/degrees : Retrieve All Degree and Education Levels

Demographics

• GET https://harvest.greenhouse.io/v1/demographics/answer_options : List Organization's Demographic Answer Options
• GET https://harvest.greenhouse.io/v1/demographics/answer_options/{id} : Retrieve Demographic Answer Option by ID
• GET https://harvest.greenhouse.io/v1/demographics/answers : List Organization's Demographic Answers
• GET https://harvest.greenhouse.io/v1/demographics/answers/{id} : Retrieve Demographic Answer by ID
• GET https://harvest.greenhouse.io/v1/demographics/question_sets : List Organization's Demographic Question Sets
• GET https://harvest.greenhouse.io/v1/demographics/question_sets/{id} : Retrieve Demographic Question Set by ID
• GET https://harvest.greenhouse.io/v1/demographics/question_sets/{id}/questions : List Demographic Questions for a Question Set
• GET https://harvest.greenhouse.io/v1/demographics/questions : List Organization's Demographic Questions
• GET https://harvest.greenhouse.io/v1/demographics/questions/{id} : Retrieve Demographic Question by ID
• GET https://harvest.greenhouse.io/v1/demographics/questions/{id}/answer_options : List Demographic Answer Options

Departments

• GET https://harvest.greenhouse.io/v1/departments : List Organization's Departments
• PATCH https://harvest.greenhouse.io/v1/departments/{id} : Edit Department's Basic Information

Disciplines

• GET https://harvest.greenhouse.io/v1/disciplines : List Organization's Disciplines

EEOC

• GET https://harvest.greenhouse.io/v1/eeoc : List Organization's EEOC Data

Email Templates

• GET https://harvest.greenhouse.io/v1/email_templates : List Organization's Email Templates
• GET https://harvest.greenhouse.io/v1/email_templates/{id} : Retrieve Email Template by ID

Job Posts

• GET https://harvest.greenhouse.io/v1/job_posts : List Organization's Job Posts
• GET https://harvest.greenhouse.io/v1/job_posts/{id} : Get Single Job Post
• GET https://harvest.greenhouse.io/v1/job_posts/{id}/custom_locations : List Custom Location Options for Job Post

Job Stages

• GET https://harvest.greenhouse.io/v1/job_stages : List Organization's Job Stages
• GET https://harvest.greenhouse.io/v1/job_stages/{id} : Retrieve Job Stage by ID

Jobs

• GET https://harvest.greenhouse.io/v1/jobs : List Organization's Jobs
• PATCH https://harvest.greenhouse.io/v1/jobs/{id} : Update Job Details
• GET https://harvest.greenhouse.io/v1/jobs/{id}/approval_flows : List all of a job’s approval flows
• GET https://harvest.greenhouse.io/v1/jobs/{id}/hiring_team : Get Hiring Team for a Job
• GET https://harvest.greenhouse.io/v1/jobs/{id}/job_post : Retrieve Job Post by Job ID
• GET https://harvest.greenhouse.io/v1/jobs/{id}/job_posts : List Job Posts for a Given Job ID
• GET https://harvest.greenhouse.io/v1/jobs/{id}/stages : Retrieve Job Stages by Job ID
• PUT https://harvest.greenhouse.io/v1/jobs/{job_id}/approval_flows : Create or Replace Approval Flow for a Job or Offer
• POST https://harvest.greenhouse.io/v1/jobs/{job_id}/openings : Create Job Openings in Greenhouse
• PATCH https://harvest.greenhouse.io/v1/jobs/{job_id}/openings/{id} : Update Job Opening Details

Offers

• GET https://harvest.greenhouse.io/v1/offers : Get All Offers Made by an Organization
• GET https://harvest.greenhouse.io/v1/offers/{id} : Retrieve Offer by ID

Offices

• POST https://harvest.greenhouse.io/v1/offices : Create a New Office
• PATCH https://harvest.greenhouse.io/v1/offices/{id} : Edit Office Basic Information

Prospect Pools

• GET https://harvest.greenhouse.io/v1/prospect_pools : List Organization's Prospect Pools
• GET https://harvest.greenhouse.io/v1/prospect_pools/{id} : Retrieve Prospect Pool

Prospects

• POST https://harvest.greenhouse.io/v1/prospects : Create a New Prospect in Greenhouse

Rejection Reasons

• GET https://harvest.greenhouse.io/v1/rejection_reasons : List Organization's Rejection Reasons

Scheduled Interviews

• GET https://harvest.greenhouse.io/v1/scheduled_interviews : List Scheduled Interviews for an Organization
• DELETE https://harvest.greenhouse.io/v1/scheduled_interviews/{id} : Delete a Scheduled Interview by ID
• POST https://harvest.greenhouse.io/v2/scheduled_interviews : Create a New Scheduled Interview
• PATCH https://harvest.greenhouse.io/v2/scheduled_interviews/{id} : Update a Scheduled Interview

Schools

• GET https://harvest.greenhouse.io/v1/schools : List Organization's Schools

Scorecards

• GET https://harvest.greenhouse.io/v1/scorecards : List Organization's Scorecards
• GET https://harvest.greenhouse.io/v1/scorecards/{id} : Retrieve Scorecard

Sources

• GET https://harvest.greenhouse.io/v1/sources : List Organization's Sources Grouped by Strategy

Tags

• POST https://harvest.greenhouse.io/v1/tags/candidate : Add a New Candidate Tag to Organization
• DELETE https://harvest.greenhouse.io/v1/tags/candidate/{tag id} : Remove Candidate Tag from Organization

Tracking Links

• GET https://harvest.greenhouse.io/v1/tracking_links/{token} : Retrieve Tracking Link Data

User Roles

• GET https://harvest.greenhouse.io/v1/user_roles : List Organization's Roles for User Assignment

Users

• POST https://harvest.greenhouse.io/v1/users : Create a New User with Basic Permissions
• PATCH https://harvest.greenhouse.io/v1/users/permission_level : Change User Permission Level to Basic
• GET https://harvest.greenhouse.io/v1/users/{id} : Retrieve User Details
• POST https://harvest.greenhouse.io/v1/users/{id}/email_addresses : Create Unverified Email Address for User
• DELETE https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs : Delete User's Future Job Permission
• POST https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs : Create Job Permission for User
• GET https://harvest.greenhouse.io/v1/users/{user_id}/pending_approvals : Get Pending Approvals for User
• PATCH https://harvest.greenhouse.io/v2/users/ : Edit User's Basic Information
• PATCH https://harvest.greenhouse.io/v2/users/disable : Disable a User
• PATCH https://harvest.greenhouse.io/v2/users/enable : Enable a User in Greenhouse

Job Posts (v2)

• PATCH https://harvest.greenhouse.io/v2/job_posts/{id} : Update Job Post Properties
• PATCH https://harvest.greenhouse.io/v2/job_posts/{id}/status : Update Job Post Status

Jobs (v2)

• DELETE https://harvest.greenhouse.io/v2/jobs/{job_id}/openings : Delete Job Openings

‍

Greenhouse API FAQs

How do I generate an API key in Greenhouse?

• Answer: To generate an API key in Greenhouse:some text
  1. Click the Configure icon on your navigation bar.
  2. Navigate to Dev Center > API Credential Management.
  3. Click Create New API Key.
  4. Select the API type (e.g., Harvest) and provide a description.
  5. Click Create and copy the generated API key to a secure location.
• Source: Create a Harvest API key for an integration – Greenhouse Support

What authentication method does the Greenhouse API use?

• Answer: The Greenhouse API uses HTTP Basic Authentication. The API key serves as the username, and the password should be left blank. Include the 'Authorization' header in your HTTP requests, formatted as 'Basic {Base64EncodedAPIKey:}'.
• Source: Harvest API | Greenhouse - Greenhouse Software

Are there rate limits for the Greenhouse API?

• Answer: Yes, Greenhouse enforces rate limits to ensure fair usage:some text
  • Harvest API: 50 requests per 10 seconds.
  • Exceeding the limit will return an HTTP 429 response.
• Source: Harvest API | Greenhouse - Greenhouse Software

Can I retrieve candidate information using the Greenhouse API?

• Answer: Yes, you can retrieve candidate information using the Harvest API. For example, to list all candidates, make a GET request to the /v1/candidates/ endpoint.
• Source: Harvest API | Greenhouse - Greenhouse Software

Does the Greenhouse API support webhooks?

• Answer: Yes, Greenhouse supports webhooks, allowing you to receive real-time notifications for specific events, such as candidate application submissions or status changes.
• Source: Developer Resources | Greenhouse

‍

Get Started with Greenhouse API Integration

For quick and seamless integration with Greenhouse API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Greenhouse API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 Greenhouse API.‍

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

‍

BreatheHR is a comprehensive HR management software designed to streamline human resource processes for small to medium-sized businesses. By offering a centralized platform, it enables organizations to efficiently manage personal data, company documents, holiday requests, expenses, and sick leave. This user-friendly software enhances workforce connectivity and ensures that HR tasks are handled with precision and ease, allowing businesses to focus on growth and productivity.

One of the standout features of BreatheHR is its ability to integrate seamlessly with other business tools through the BreatheHR API. This integration capability allows businesses to customize their HR management experience, ensuring that all systems work in harmony. By leveraging the BreatheHR API, companies can automate data flows, reduce manual entry, and maintain accurate records, ultimately leading to improved efficiency and decision-making. As businesses continue to evolve, BreatheHR remains a vital tool in the HR domain, offering flexibility and scalability to meet diverse organizational needs.

Key highlights of BreatheHR APIs

• Easy Data Access:
  • The breatheHR API allows seamless integration with existing systems, providing effortless access to employee data across multiple applications.
• Automation:
  • Automate business operations and data flow across systems, reducing manual data entry and saving time.
• Custom Integration:
  • Open-source and developer-friendly, the breatheHR API supports custom integrations with third-party software for tailored solutions.
• Developer-Friendly:
  • Designed with developers in mind, the API offers flexibility and ease of use for creating custom solutions.

BreatheHR API Endpoints

Absences

• get https://api.breathehr.com/v1/absences : Get Absences
• post https://api.breathehr.com/v1/absences/{id}/cancel : Cancel Absence Request

Account

• get https://api.breathehr.com/v1/account : Get Account Details

Bonuses

• get https://api.breathehr.com/v1/bonuses : Get Bonuses

Change Requests

• get https://api.breathehr.com/v1/change_requests : Get Change Requests

Company

• get https://api.breathehr.com/v1/company_training_types : Get Company Training Types
• get https://api.breathehr.com/v1/departments : Get Company Departments
• get https://api.breathehr.com/v1/divisions : Get Company Divisions
• get https://api.breathehr.com/v1/locations : Get Company Locations

Department

• get https://api.breathehr.com/v1/departments/{id}/absences : Get Department Absences
• get https://api.breathehr.com/v1/departments/{id}/benefits : Get Department Benefits
• get https://api.breathehr.com/v1/departments/{id}/bonuses : Get Department Bonuses
• get https://api.breathehr.com/v1/departments/{id}/leave_requests : Get Leave Requests for a Department
• get https://api.breathehr.com/v1/departments/{id}/salaries : Get Department Salaries

Employee Expenses

• post https://api.breathehr.com/v1/employee_expense_claims : Create Employee Expense Claims
• put https://api.breathehr.com/v1/employee_expense_claims/{id} : Update Employee Expense Claim
• post https://api.breathehr.com/v1/employee_expenses : Create Employee Expenses
• get https://api.breathehr.com/v1/employee_expenses/{id} : Get Employee Expenses by ID

Employee

• get https://api.breathehr.com/v1/employee_jobs : Get Employee Jobs
• get https://api.breathehr.com/v1/employee_training_courses : Get Employee Training Courses
• delete https://api.breathehr.com/v1/employee_training_courses/{id} : Delete Employee Training Course
• post https://api.breathehr.com/v1/employees : Create New Employee Record
• post https://api.breathehr.com/v1/employees/{employee_id}/change_requests/{id}/approve : Approve Employee Change Request
• get https://api.breathehr.com/v1/employees/{id} : Get Employee Details
• get https://api.breathehr.com/v1/employees/{id}/absences : Get Employee Absences
• get https://api.breathehr.com/v1/employees/{id}/benefits : Get Employee Benefits
• get https://api.breathehr.com/v1/employees/{id}/bonuses : Get Employee Bonuses
• post https://api.breathehr.com/v1/employees/{id}/change_requests : Create Employee Change Request
• post https://api.breathehr.com/v1/employees/{id}/leave_requests : Create Leave Request for Employee
• get https://api.breathehr.com/v1/employees/{id}/sicknesses : Get Employee Sickness Records

Leave Requests

• get https://api.breathehr.com/v1/leave_requests : Get Leave Requests
• get https://api.breathehr.com/v1/leave_requests/{id} : Get Leave Request Details
• post https://api.breathehr.com/v1/leave_requests/{id}/approve : Approve Leave Request
• get https://api.breathehr.com/v1/leave_requests/{id}/cancelling : Get Leave Request Cancelling Details
• post https://api.breathehr.com/v1/leave_requests/{id}/reject : Reject Leave Request

Holiday

• get https://api.breathehr.com/v1/holiday_allowances : Get Holiday Allowances
• get https://api.breathehr.com/v1/statutory_holiday_countries : Get Statutory Holiday Countries

Other

• get https://api.breathehr.com/v1/other_leave_reasons : Get Other Leave Reasons
• get https://api.breathehr.com/v1/salaries : Get Employee Salaries
• get https://api.breathehr.com/v1/sicknesses : Get Sickness Records
• delete https://api.breathehr.com/v1/sicknesses/{id} : Delete Sickness Record
• get https://api.breathehr.com/v1/working_patterns : Get Working Patterns

‍

BreatheHR API FAQs

How do I enable API access in BreatheHR?

• Answer: To enable API access in BreatheHR:some text
  1. Log in to your BreatheHR account as an Admin.
  2. Navigate to Configure > Settings > Integrations > API Setup.
  3. Click on Enable API and confirm the action.
  4. Once enabled, your production API key will be displayed.
• Source: How to enable the Breathe API | Breathe Knowledgebase

What authentication method does the BreatheHR API use?

• Answer: The BreatheHR API uses API key-based authentication. Include your API key in the X-API-KEY header of your HTTP requests to authenticate.
• Source: Breathe Developer Documentation

Are there rate limits for the BreatheHR API?

• Answer: The official documentation does not specify explicit rate limits for the BreatheHR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
• Source: Breathe Developer Documentation

Can I retrieve employee data using the BreatheHR API?

• Answer: Yes, you can retrieve employee data by making a GET request to the /employees endpoint. This will return a list of employees and their details.
• Source: Breathe Developer Documentation

Does the BreatheHR API support webhooks?

• Answer: As of the latest available information, the BreatheHR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
• Source: Breathe Developer Documentation

‍

Get Started with BreatheHR API Integration

For quick and seamless integration with BreatheHR API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any BreatheHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 BreatheHR API.‍

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

Sage-ATS, also known as Sage People or Sage HR, is a comprehensive cloud-based human resources management solution that integrates an advanced Applicant Tracking System (ATS). This innovative software is specifically designed to streamline the hiring process, making it an indispensable tool for businesses aiming to enhance their recruitment strategies. By automating and organizing recruitment activities, Sage-ATS empowers organizations to attract, hire, and manage talent more efficiently. Key features include candidate tracking, seamless job board integration, and a visual pipeline tool that provides a clear overview of the hiring funnel, all of which contribute to reducing the time-to-fill positions and improving the overall candidate experience.

Serving the domain of human resources, Sage-ATS focuses on talent acquisition and recruitment management, addressing common HR challenges with its robust functionalities. The software's ability to integrate with various platforms through the Sage Recruitment API further enhances its utility, allowing businesses to customize and optimize their recruitment processes. This API integration process is crucial for organizations seeking to leverage Sage-ATS's full potential, ensuring a smooth and efficient recruitment workflow. As a result, Sage-ATS not only simplifies recruitment but also supports strategic HR initiatives, making it a vital asset for modern businesses.

Key highlights of Sage-ATS APIs

• 1. Automation and Efficiency:
  • Automates recruitment, selection, and onboarding processes, improving efficiency and reducing manual work.
• 2. Seamless Integration:
  • Ensures smooth data flow by integrating with various applications and systems, reducing manual data entry.
• 3. Enhanced Productivity:
  • Improves overall productivity and efficiency by integrating with other systems.
• 4. Custom Integration:
  • Supports custom integration features, allowing data imports from non-natively supported systems, providing flexibility.
• 5. Bi-directional Synchronization:
  • Ensures consistent data updates across integrated systems through bi-directional synchronization.
• 6. Unified API Access:
  • Simplifies integration for applications interacting with multiple ATS platforms by unifying them into a single access point.

Sage-ATS API Endpoints

Applicant Endpoints

• GET https://subdomain.sage.hr/api/recruitment/applicants/{id} : Get Applicant Details
• GET https://subdomain.sage.hr/api/recruitment/applicants/{id}/actions : List Applicant's Recruitment Pipeline Actions

Position Endpoints

• GET https://subdomain.sage.hr/api/recruitment/positions : List Recruitment Positions
• GET https://subdomain.sage.hr/api/recruitment/positions/{id} : Get Position Details
• GET https://subdomain.sage.hr/api/recruitment/positions/{id}/applicants : List Applicants for a Position

Sage HR ATS API FAQs

1. How do I enable API access in Sage HR ATS?some text
   • Answer: To enable API access in Sage HR:some text
     1. Click on your name in the top-right corner and select Settings.
     2. Navigate to Integrations > API.
     3. Click Enable API Access to activate the API and generate your unique API key.
   • Source: How does Sage HR API work?
2. What authentication method does the Sage HR ATS API use?some text
   • Answer: The Sage HR API uses an API key for authentication. Include your API key in the X-Auth-Token header of every request sent to the endpoint URL.
   • Source: How does Sage HR API work?
3. Are there rate limits for the Sage HR ATS API?some text
   • Answer: The official documentation does not specify explicit rate limits for the Sage HR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
   • Source: Sage HR API Reference
4. Can I retrieve employee data using the Sage HR ATS API?some text
   • Answer: Yes, you can retrieve employee data by making a GET request to the /employees endpoint. This will list active employees in the company.
   • Source: Sage HR API Reference
5. Does the Sage HR ATS API support webhooks?some text
   • Answer: As of the latest available information, the Sage HR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
   • Source: Sage HR API Reference

‍

Get Started with Sage HR ATS API Integration

For quick and seamless integration with Sage HR API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Sage HR API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 Sage ATS API.‍

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

Zoho Books is a robust cloud-based accounting software designed to streamline financial management for small and medium-sized businesses. As part of the comprehensive Zoho suite of business applications, Zoho Books offers a wide array of features that cater to diverse accounting needs. It empowers businesses to efficiently manage their financial operations, from invoicing and expense tracking to inventory management and tax compliance. With its user-friendly interface and powerful tools, Zoho Books simplifies complex accounting tasks, enabling businesses to focus on growth and profitability.

One of the standout features of Zoho Books is its ability to seamlessly integrate with various third-party applications through the Zoho Books API. This integration capability allows businesses to customize their accounting processes and connect Zoho Books with other essential business tools, enhancing productivity and operational efficiency. The Zoho Books API provides developers with the flexibility to automate workflows, synchronize data, and build custom solutions tailored to specific business requirements, making it an invaluable asset for businesses looking to optimize their financial management systems.

Zoho Books API Endpoints

Bank Accounts

• GET https://www.zohoapis.com/books/v3/bankaccounts : List view of accounts
• GET https://www.zohoapis.com/books/v3/bankaccounts/rules : Get Rules List
• GET https://www.zohoapis.com/books/v3/bankaccounts/rules/{rule_id} : Get a rule
• DELETE https://www.zohoapis.com/books/v3/bankaccounts/rules/{rule_id}?organization_id={organization_id} : Delete a rule
• POST https://www.zohoapis.com/books/v3/bankaccounts/rules?organization_id={organization_id} : Create a rule
• PUT https://www.zohoapis.com/books/v3/bankaccounts/{accountId} : Update bank account
• POST https://www.zohoapis.com/books/v3/bankaccounts/{account_id}/active : Activate account
• POST https://www.zohoapis.com/books/v3/bankaccounts/{account_id}/inactive : Deactivate account
• GET https://www.zohoapis.com/books/v3/bankaccounts/{bank_account_id}/statement/lastimported : Get last imported statement
• DELETE https://www.zohoapis.com/books/v3/bankaccounts/{bank_account_id}/statement/{statement_id}?organization_id={organization_id} : Delete last imported statement
• POST https://www.zohoapis.com/books/v3/bankaccounts?organization_id={organization_id} : Create a bank account

Bank Statements

• POST https://www.zohoapis.com/books/v3/bankstatements?organization_id={organization_id} : Import a Bank/Credit Card Statement

Bank Transactions

• GET https://www.zohoapis.com/books/v3/banktransactions : Get transactions list
• GET https://www.zohoapis.com/books/v3/banktransactions/?organization_id={organization_id} : Get transaction
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorized/categorize/paymentrefunds?organization_id={organization_id} : Categorize as Customer Payment Refund
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorized/categorize/vendorpaymentrefunds?organization_id={organization_id} : Categorize as Vendor Payment Refund
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorized/{transaction_id}/exclude : Exclude a transaction
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/creditnoterefunds?organization_id={organization_id} : Categorize as credit note refunds
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/customerpayments?organization_id={organization_id} : Categorize as customer payment
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/expenses?organization_id={organization_id} : Categorize as expense
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/vendorcreditrefunds?organization_id={organization_id} : Categorize as vendor credit refunds
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/vendorpayments?organization_id={organization_id} : Categorize a vendor payment
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize?organization_id={organization_id} : Categorize an uncategorized transaction
• GET https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/match : Get matching transactions
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/match?organization_id={organization_id} : Match a transaction
• POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/restore : Restore a transaction
• POST https://www.zohoapis.com/books/v3/banktransactions/{transaction_id}/uncategorize : Uncategorize a categorized transaction
• POST https://www.zohoapis.com/books/v3/banktransactions/{transaction_id}/unmatch : Unmatch a matched transaction
• POST https://www.zohoapis.com/books/v3/banktransactions?organization_id={organization_id} : Create a transaction for an account

Base Currency Adjustment

• GET https://www.zohoapis.com/books/v3/basecurrencyadjustment : List base currency adjustment
• GET https://www.zohoapis.com/books/v3/basecurrencyadjustment/accounts : List account details for base currency adjustment
• DELETE https://www.zohoapis.com/books/v3/basecurrencyadjustment/{adjustment_id}?organization_id={organization_id} : Delete a base currency adjustment
• GET https://www.zohoapis.com/books/v3/basecurrencyadjustments/{basecurrencyadjustment_id}?organization_id={organization_id} : Get a base currency adjustment

Bills

• PUT https://www.zohoapis.com/books/v3/bill/{bill_id}/customfields : Update custom field in existing bills
• POST https://www.zohoapis.com/books/v3/bills : Create a bill
• GET https://www.zohoapis.com/books/v3/bills/editpage/frompurchaseorders : Convert PO to Bill
• PUT https://www.zohoapis.com/books/v3/bills/{billId} : Update a bill
• POST https://www.zohoapis.com/books/v3/bills/{bill_id}/approve : Approve a bill
• GET https://www.zohoapis.com/books/v3/bills/{bill_id}/attachment : Get a bill attachment
• GET https://www.zohoapis.com/books/v3/bills/{bill_id}/comments : List bill comments & history
• POST https://www.zohoapis.com/books/v3/bills/{bill_id}/comments?organization_id={organization_id} : Add comment to a bill
• GET https://www.zohoapis.com/books/v3/bills/{bill_id}/payments : List bill payments
• POST https://www.zohoapis.com/books/v3/bills/{bill_id}/status/open : Mark a bill as open
• POST https://www.zohoapis.com/books/v3/bills/{bill_id}/status/void : Void a bill
• POST https://www.zohoapis.com/books/v3/bills/{bill_id}/submit : Submit a bill for approval
• GET https://www.zohoapis.com/books/v3/bills/{bill_id}?organization_id={organization_id} : Get a bill
• POST https://www.zohoapis.com/books/v3/bills?organization_id={organization_id} : Create a bill

Chart of Accounts

• GET https://www.zohoapis.com/books/v3/chartofaccounts : List chart of accounts
• GET https://www.zohoapis.com/books/v3/chartofaccounts/transactions : List of transactions for an account
• DELETE https://www.zohoapis.com/books/v3/chartofaccounts/transactions/{transaction_id} : Delete a transaction
• GET https://www.zohoapis.com/books/v3/chartofaccounts/{accountId} : Get an account
• POST https://www.zohoapis.com/books/v3/chartofaccounts/{account_id}/active : Mark an account as active
• POST https://www.zohoapis.com/books/v3/chartofaccounts/{account_id}/inactive : Mark an account as inactive
• DELETE https://www.zohoapis.com/books/v3/chartofaccounts/{account_id}?organization_id={organization_id} : Delete a Bank account
• POST https://www.zohoapis.com/books/v3/chartofaccounts?organization_id={organization_id} : Create an account

Custom Modules

• DELETE https://www.zohoapis.com/books/v3/cm_debtor : Delete Custom Modules
• DELETE https://www.zohoapis.com/books/v3/cm_debtor/{record_id}?organization_id={organization_id} : Delete individual records

Contacts

• GET https://www.zohoapis.com/books/v3/contacts : List Contacts
• POST https://www.zohoapis.com/books/v3/contacts/contactpersons/{contact_person_id}/primary : Mark as primary contact person
• PUT https://www.zohoapis.com/books/v3/contacts/contactpersons/{contact_person_id}?organization_id={organization_id} : Update a contact person
• POST https://www.zohoapis.com/books/v3/contacts/contactpersons?organization_id={organization_id} : Create a contact person
• PUT https://www.zohoapis.com/books/v3/contacts/{contactId} : Update a Contact
• POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/active : Mark as Active
• GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/address : Get Contact Addresses
• DELETE https://www.zohoapis.com/books/v3/contacts/{contact_id}/address/{address_id}?organization_id={organization_id} : Delete Additional Address
• POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/address?organization_id={organization_id} : Add Additional Address
• GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/comments : List Comments
• GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/contactpersons : List contact persons
• GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/contactpersons/{contact_person_id} : Get a contact person
• POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/email?organization_id={organization_id} : Email Contact
• POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/inactive : Mark as Inactive
• POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/paymentreminder/disable : Disable Payment Reminders
• POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/paymentreminder/enable : Enable Payment Reminders
• POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/portal/enable?organization_id={organization_id} : Enable Portal Access
• GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/refunds : List Refunds
• GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/statements/email?organization_id={organization_id} : Get Statement Mail Content
• POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/track1099 : Track a contact for 1099 reporting
• POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/untrack1099 : Untrack 1099
• DELETE https://www.zohoapis.com/books/v3/contacts/{contact_id}?organization_id={organization_id} : Delete a Contact
• PUT https://www.zohoapis.com/books/v3/contacts?organization_id={organization_id} : Update a contact using a custom field's unique value

Credit Notes

• GET https://www.zohoapis.com/books/v3/creditnotes : List all Credit Notes
• GET https://www.zohoapis.com/books/v3/creditnotes/refunds : List credit note refunds
• GET https://www.zohoapis.com/books/v3/creditnotes/templates : List credit note template
• POST https://www.zohoapis.com/books/v3/creditnotes/{credit_note_id}/status/open : Convert Credit Note to Open
• GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id} : Get a credit note
• POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/approve : Approve a credit note
• GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/comments : List credit note comments & history
• GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/email : Get email content of a credit note
• POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/email?organization_id={organization_id} : Email a credit note
• GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/emailhistory : Email history
• GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/invoices : List invoices credited
• DELETE https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/invoices/{invoice_id} : Delete invoices credited
• POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/invoices?organization_id={organization_id} : Credit to an invoice
• GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/refunds : List refunds of a credit note
• GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id} : Get credit note refund
• PUT https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/refunds/{refund_id}?organization_id={organization_id} : Update credit note refund
• POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/refunds?organization_id={organization_id} : Refund Credit Note
• POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/status/draft : Convert Credit Note to Draft
• POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/status/void : Void a Credit Note
• POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/submit?organization_id={organization_id} : Submit a credit note for approval
• PUT https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/templates/{template_id}?organization_id={organization_id} : Update a credit note template
• DELETE https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}?organization_id={organization_id} : Delete a credit note
• POST https://www.zohoapis.com/books/v3/creditnotes?organization_id={organization_id} : Create a credit note

CRM

• POST https://www.zohoapis.com/books/v3/crm/account/import?organization_id={organization_id} : Import a customer using the CRM account ID
• POST https://www.zohoapis.com/books/v3/crm/contact/import?organization_id={organization_id} : Import a customer using CRM contact ID
• POST https://www.zohoapis.com/books/v3/crm/vendor/import : Import a vendor using the CRM vendor ID

Customer Payments

• PUT https://www.zohoapis.com/books/v3/customerpayment/{customerpayment_id}/customfields : Update custom field in existing customerpayments
• GET https://www.zohoapis.com/books/v3/customerpayments : List Customer Payments
• PUT https://www.zohoapis.com/books/v3/customerpayments/{customerpayment_id}/refunds/?organization_id={organization_id} : Update a refund
• POST https://www.zohoapis.com/books/v3/customerpayments/{customerpayment_id}/refunds?organization_id={organization_id} : Refund an excess customer payment
• PUT https://www.zohoapis.com/books/v3/customerpayments/{paymentId} : Update a payment
• GET https://www.zohoapis.com/books/v3/customerpayments/{payment_id}/refunds : List refunds of a customer payment
• DELETE https://www.zohoapis.com/books/v3/customerpayments/{payment_id}/refunds/?organization_id={organization_id} : Delete a Refund
• GET https://www.zohoapis.com/books/v3/customerpayments/{payment_id}?organization_id={organization_id} : Retrieve a payment
• PUT https://www.zohoapis.com/books/v3/customerpayments?organization_id={organization_id} : Update a payment using a custom field's unique value

Debtor

• GET https://www.zohoapis.com/books/v3/debtor : Get Record List of a Custom Module
• POST https://www.zohoapis.com/books/v3/debtor?organization_id={organization_id} : Create Custom Modules
• GET https://www.zohoapis.com/books/v3/debtors/{debtor_id} : Get Individual Record Details
• PUT https://www.zohoapis.com/books/v3/debtors/{debtor_id}?organization_id={organization_id} : Update Custom Module

Employees

• DELETE https://www.zohoapis.com/books/v3/employee/?organization_id={organization_id} : Delete an employee
• GET https://www.zohoapis.com/books/v3/employees : List employees
• GET https://www.zohoapis.com/books/v3/employees/?organization_id={organization_id} : Get an employee
• POST https://www.zohoapis.com/books/v3/employees?organization_id={organization_id} : Create an employee

Estimates

• GET https://www.zohoapis.com/books/v3/estimates : List estimates
• POST https://www.zohoapis.com/books/v3/estimates/email : Email multiple estimates
• GET https://www.zohoapis.com/books/v3/estimates/pdf : Bulk export estimates
• GET https://www.zohoapis.com/books/v3/estimates/print : Bulk print estimates
• GET https://www.zohoapis.com/books/v3/estimates/templates : List Estimate Template
• GET https://www.zohoapis.com/books/v3/estimates/{estimate_id} : Get an estimate
• POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/approve : Approve an estimate.
• GET https://www.zohoapis.com/books/v3/estimates/{estimate_id}/comments : List estimate comments & history
• POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/comments?organization_id={organization_id} : Add Comments to Estimate
• PUT https://www.zohoapis.com/books/v3/estimates/{estimate_id}/customfields : Update custom field in existing estimates
• GET https://www.zohoapis.com/books/v3/estimates/{estimate_id}/email : Get estimate email content
• POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/email?organization_id={organization_id} : Email an estimate
• POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/status/accepted : Mark an estimate as accepted
• POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/status/declined : Mark an estimate as declined
• POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/status/sent : Mark an estimate as sent
• POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/submit : Submit an estimate for approval
• PUT https://www.zohoapis.com/books/v3/estimates/{estimate_id}/templates/{template_id}?organization_id={organization_id} : Update estimate template
• PUT https://www.zohoapis.com/books/v3/estimates/{estimate_id}?organization_id={organization_id} : Update an Estimate
• POST https://www.zohoapis.com/books/v3/estimates?organization_id={organization_id} : Create an Estimate

Expenses

• GET https://www.zohoapis.com/books/v3/expenses : List Expenses
• GET https://www.zohoapis.com/books/v3/expenses/{expense_id} : Get an Expense
• GET https://www.zohoapis.com/books/v3/expenses/{expense_id}/comments : List expense History & Comments
• POST https://www.zohoapis.com/books/v3/expenses/{expense_id}/receipt : Add receipt to an expense
• PUT https://www.zohoapis.com/books/v3/expenses/{expense_id}?organization_id={organization_id} : Update an Expense
• PUT https://www.zohoapis.com/books/v3/expenses?organization_id={organization_id} : Update an expense using a custom field's unique value

Invoices

• PUT https://www.zohoapis.com/books/v3/invoice/{invoice_id}/customfields : Update custom field in existing invoices
• POST https://www.zohoapis.com/books/v3/invoices : Create an invoice
• POST https://www.zohoapis.com/books/v3/invoices/email : Email invoices
• DELETE https://www.zohoapis.com/books/v3/invoices/expenses/receipt?organization_id={organization_id} : Delete the expense receipt
• POST https://www.zohoapis.com/books/v3/invoices/fromsalesorder : Create an instant invoice
• POST https://www.zohoapis.com/books/v3/invoices/paymentreminder : Bulk invoice reminder
• GET https://www.zohoapis.com/books/v3/invoices/pdf : Bulk export Invoices
• GET https://www.zohoapis.com/books/v3/invoices/print : Bulk print invoices
• GET https://www.zohoapis.com/books/v3/invoices/templates : List invoice templates
• PUT https://www.zohoapis.com/books/v3/invoices/{invoiceId} : Update an invoice
• PUT https://www.zohoapis.com/books/v3/invoices/{invoice_id}/address/billing?organization_id={organization_id} : Update billing address
• PUT https://www.zohoapis.com/books/v3/invoices/{invoice_id}/address/shipping?organization_id={organization_id} : Update shipping address
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/approve : Approve an invoice
• GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}/attachment : Get an invoice attachment
• DELETE https://www.zohoapis.com/books/v3/invoices/{invoice_id}/attachment?organization_id={organization_id} : Delete an attachment
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/comments : Add comment to an invoice
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/credits?organization_id={organization_id} : Apply credits
• GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}/creditsapplied : List credits applied
• DELETE https://www.zohoapis.com/books/v3/invoices/{invoice_id}/creditsapplied/{credit_id} : Delete applied credit
• GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}/email : Get invoice email content
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/email?organization_id={organization_id} : Email an invoice
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/paymentreminder/disable : Disable payment reminder
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/paymentreminder/enable : Enable payment reminder
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/paymentreminder?organization_id={organization_id} : Remind Customer
• GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}/payments : List invoice payments
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/status/draft : Mark as draft
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/status/sent : Mark an invoice as sent
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/status/void : Void an invoice
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/submit?organization_id={organization_id} : Submit an invoice for approval
• PUT https://www.zohoapis.com/books/v3/invoices/{invoice_id}/templates/{template_id}?organization_id={organization_id} : Update invoice template
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/writeoff : Write off invoice
• POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/writeoff/cancel : Cancel write off
• GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}?organization_id={organization_id} : Get an invoice
• PUT https://www.zohoapis.com/books/v3/invoices?organization_id={organization_id} : Update an invoice using a custom field's unique value

Items

• PUT https://www.zohoapis.com/books/v3/item/{item_id}/customfields : Update custom field in existing items
• GET https://www.zohoapis.com/books/v3/items : List items
• PUT https://www.zohoapis.com/books/v3/items/{item_id}?organization_id={organization_id} : Update an item
• PUT https://www.zohoapis.com/books/v3/items?organization_id={organization_id} : Update an item using a custom field's unique value

Journals

• GET https://www.zohoapis.com/books/v3/journals : Get journal list
• POST https://www.zohoapis.com/books/v3/journals/comments?organization_id={organization_id} : Add comment to a journal
• GET https://www.zohoapis.com/books/v3/journals/{journalEntryId} : Get journal
• POST https://www.zohoapis.com/books/v3/journals/{journal_id}/attachment?organization_id={organization_id} : Add attachment to a journal
• POST https://www.zohoapis.com/books/v3/journals/{journal_id}/status/publish : Mark a journal as published
• DELETE https://www.zohoapis.com/books/v3/journals/{journal_id}?organization_id={organization_id} : Delete a journal
• POST https://www.zohoapis.com/books/v3/journals?organization_id={organization_id} : Create a journal

Projects

• GET https://www.zohoapis.com/books/v3/projects : List projects
• GET https://www.zohoapis.com/books/v3/projects/timeentries : List time entries
• GET https://www.zohoapis.com/books/v3/projects/timeentries/runningtimer/me?organization_id={organization_id} : Get current running timer
• POST https://www.zohoapis.com/books/v3/projects/timeentries/timer/stop?organization_id={organization_id} : Stop timer
• DELETE https://www.zohoapis.com/books/v3/projects/timeentries/{time_entry_id}?organization_id={organization_id} : Delete time entry
• GET https://www.zohoapis.com/books/v3/projects/timeentries/{timeentrie_id} : Get a time entry
• POST https://www.zohoapis.com/books/v3/projects/timeentries/{timeentrie_id}/timer/start?organization_id={organization_id} : Start timer
• PUT https://www.zohoapis.com/books/v3/projects/timeentries/{timeentrie_id}?organization_id={organization_id} : Update time entry
• DELETE https://www.zohoapis.com/books/v3/projects/timeentries?organization_id={organization_id} : Delete time entries
• GET https://www.zohoapis.com/books/v3/projects/{project_id} : Get a project
• POST https://www.zohoapis.com/books/v3/projects/{project_id}/active : Activate project
• POST https://www.zohoapis.com/books/v3/projects/{project_id}/clone?organization_id={organization_id} : Clone project
• GET https://www.zohoapis.com/books/v3/projects/{project_id}/comments : List comments
• DELETE https://www.zohoapis.com/books/v3/projects/{project_id}/comments/{comment_id} : Delete comment
• POST https://www.zohoapis.com/books/v3/projects/{project_id}/comments?organization_id={organization_id} : Post comment
• POST https://www.zohoapis.com/books/v3/projects/{project_id}/inactive : Inactivate a project
• GET https://www.zohoapis.com/books/v3/projects/{project_id}/tasks : List tasks
• GET https://www.zohoapis.com/books/v3/projects/{project_id}/tasks/{task_id} : Get a task
• PUT https://www.zohoapis.com/books/v3/projects/{project_id}/tasks/{task_id}?organization_id={organization_id} : Update a task
• POST https://www.zohoapis.com/books/v3/projects/{project_id}/tasks?organization_id={organization_id} : Add a task
• GET https://www.zohoapis.com/books/v3/projects/{project_id}/users : List Users
• POST https://www.zohoapis.com/books/v3/projects/{project_id}/users/invite?organization_id={organization_id} : Invite User to Project
• GET https://www.zohoapis.com/books/v3/projects/{project_id}/users/{user_id} : Get a User
• DELETE https://www.zohoapis.com/books/v3/projects/{project_id}/users/{user_id}?organization_id={organization_id} : Delete user
• POST https://www.zohoapis.com/books/v3/projects/{project_id}/users?organization_id={organization_id} : Assign users to a project
• DELETE https://www.zohoapis.com/books/v3/projects/{project_id}?organization_id={organization_id} : Delete project
• POST https://www.zohoapis.com/books/v3/projects?organization_id={organization_id} : Create a project

Purchase Orders

• GET https://www.zohoapis.com/books/v3/purchaseorders : List purchase orders
• DELETE https://www.zohoapis.com/books/v3/purchaseorders/?organization_id={organization_id} : Delete purchase order
• GET https://www.zohoapis.com/books/v3/purchaseorders/templates : List purchase order templates
• GET https://www.zohoapis.com/books/v3/purchaseorders/{purchaseOrderId} : Get a purchase order
• POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/approve : Approve a purchase order
• POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/attachment : Add attachment to a purchase order
• GET https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/comments : List purchase order comments & history
• POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/comments?organization_id={organization_id} : Add comment to purchase order
• PUT https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/customfields : Update custom field in existing purchaseorders
• GET https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/email : Get purchase order email content
• POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/email?organization_id={organization_id} : Email a purchase order
• POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/status/billed : Mark as billed
• POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/status/cancelled : Cancel a purchase order
• POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/status/open : Mark a purchase order as open
• POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/submit : Submit a purchase order for approval
• PUT https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/templates/{template_id}?organization_id={organization_id} : Update purchase order template
• POST https://www.zohoapis.com/books/v3/purchaseorders?organization_id={organization_id} : Create a purchase order

Recurring Bills

• GET https://www.zohoapis.com/books/v3/recurring_bills/{recurring_bill_id} : Get a recurring bill
• DELETE https://www.zohoapis.com/books/v3/recurring_bills/{recurring_bill_id}?organization_id={organization_id} : Delete a recurring bill
• GET https://www.zohoapis.com/books/v3/recurringbills : List recurring bills
• GET https://www.zohoapis.com/books/v3/recurringbills/{recurring_bill_id}/comments : List recurring bill history
• POST https://www.zohoapis.com/books/v3/recurringbills/{recurring_bill_id}/status/resume : Resume a recurring Bill
• POST https://www.zohoapis.com/books/v3/recurringbills/{recurring_bill_id}/status/stop : Stop a recurring bill
• PUT https://www.zohoapis.com/books/v3/recurringbills/{recurring_bill_id}?organization_id={organization_id} : Update a recurring bill
• PUT https://www.zohoapis.com/books/v3/recurringbills?organization_id={organization_id} : Update a recurring bill using a custom field's unique value

Recurring Expenses

• GET https://www.zohoapis.com/books/v3/recurringexpenses : List recurring expenses
• GET https://www.zohoapis.com/books/v3/recurringexpenses/{recurring_expense_id}/comments : List recurring expense history
• POST https://www.zohoapis.com/books/v3/recurringexpenses/{recurring_expense_id}/status/resume : Resume a recurring Expense
• POST https://www.zohoapis.com/books/v3/recurringexpenses/{recurring_expense_id}/status/stop : Stop a recurring expense
• PUT https://www.zohoapis.com/books/v3/recurringexpenses/{recurring_expense_id}?organization_id={organization_id} : Update a recurring expense
• GET https://www.zohoapis.com/books/v3/recurringexpenses/{recurringexpense_id}/expenses?organization_id={organization_id} : List child expenses created
• GET https://www.zohoapis.com/books/v3/recurringexpenses/{recurringexpense_id}?organization_id={organization_id} : Get a recurring expense
• POST https://www.zohoapis.com/books/v3/recurringexpenses?organization_id={organization_id} : Create a recurring expense

Recurring Invoices

• GET https://www.zohoapis.com/books/v3/recurringinvoices : List all Recurring Invoice
• DELETE https://www.zohoapis.com/books/v3/recurringinvoices/{invoice_id}?organization_id={organization_id} : Delete a Recurring Invoice
• GET https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id} : Get a Recurring Invoice
• GET https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id}/comments : List Recurring Invoice History
• POST https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id}/status/resume : Resume a Recurring Invoice
• POST https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id}/status/stop : Stop a Recurring Invoice
• PUT https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id}/templates/{template_id} : Update Recurring Invoice Template
• PUT https://www.zohoapis.com/books/v3/recurringinvoices/{recurringinvoice_id}?organization_id={organization_id} : Update Recurring Invoice
• POST https://www.zohoapis.com/books/v3/recurringinvoices?organization_id={organization_id} : Create a Recurring Invoice

Retainer Invoices

• GET https://www.zohoapis.com/books/v3/retainerinvoices : List a retainer invoices
• POST https://www.zohoapis.com/books/v3/retainerinvoices/approve?organization_id={organization_id} : Approve a retainer invoice.
• POST https://www.zohoapis.com/books/v3/retainerinvoices/submit : Submit a retainer invoice for approval
• GET https://www.zohoapis.com/books/v3/retainerinvoices/templates : List retainer invoice templates
• GET https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/attachment : Get a retainer invoice attachment
• POST https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/attachment?organization_id={organization_id} : Add attachment to a retainer invoice
• GET https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/email : Get retainer invoice email content
• POST https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/status/sent : Mark a retainer invoice as sent
• POST https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/status/void : Void a retainer invoice
• PUT https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/templates/{template_id}?organization_id={organization_id} : Update retainer invoice template
• DELETE https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}?organization_id={organization_id} : Delete a retainer invoice
• GET https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id} : Get a retainer invoice
• GET https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id}/comments : List retainer invoice comments & history
• POST https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id}/comments?organization_id={organization_id} : Add comment to retainer invoice
• POST https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id}/email?organization_id={organization_id} : Email a retainer invoice
• PUT https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id}?organization_id={organization_id} : Update a Retainer Invoice
• POST https://www.zohoapis.com/books/v3/retainerinvoices?organization_id={organization_id} : Create a retainerinvoice

Sales Orders

• GET https://www.zohoapis.com/books/v3/salesorders : List sales orders
• GET https://www.zohoapis.com/books/v3/salesorders/pdf : Bulk export sales orders
• GET https://www.zohoapis.com/books/v3/salesorders/print : Bulk print sales orders
• GET https://www.zohoapis.com/books/v3/salesorders/templates : List sales order templates
• GET https://www.zohoapis.com/books/v3/salesorders/{salesorder_id} : Get a sales order
• POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/approve : Approve a sales order.
• PUT https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/attachment : Update attachment preference
• POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/attachment?organization_id={organization_id} : Add attachment to a sales order
• GET https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/comments : List sales order comments & history
• PUT https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/comments/{comment_id}?organization_id={organization_id} : Update comment
• POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/comments?organization_id={organization_id} : Add comment to sales order
• PUT https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/customfields : Update custom field in existing salesorders
• GET https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/email : Get sales order email content
• POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/email?organization_id={organization_id} : Email a sales order
• POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/status/open : Mark a sales order as open
• POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/status/void?organization_id={organization_id} : Mark a sales order as void
• POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/submit : Submit a sales order for approval
• POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/substatus/{substatus}?organization_id={organization_id} : Update a sales order sub status
• PUT https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/templates/{template_id}?organization_id={organization_id} : Update sales order template
• DELETE https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}?organization_id={organization_id} : Delete a sales order
• PUT https://www.zohoapis.com/books/v3/salesorders?organization_id={organization_id} : Update a sales order using a custom field's unique value

Settings

Currencies

• GET https://www.zohoapis.com/books/v3/settings/currencies : List Currencies
• GET https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id} : Get a Currency
• GET https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id}/exchangerates : List exchange rates
• PUT https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id}/exchangerates/{exchangerate_id}?organization_id={organization_id} : Update an exchange rate
• POST https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id}/exchangerates?organization_id={organization_id} : Create an exchange rate
• PUT https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id}?organization_id={organization_id} : Update a Currency
• DELETE https://www.zohoapis.com/books/v3/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id}?organization_id={organization_id} : Delete an exchange rate
• DELETE https://www.zohoapis.com/books/v3/settings/currencies/{currency_id}?organization_id={organization_id} : Delete a currency
• POST https://www.zohoapis.com/books/v3/settings/currencies?organization_id={organization_id} : Create a Currency

Opening Balances

• DELETE https://www.zohoapis.com/books/v3/settings/openingbalances : Delete opening balance
• PUT https://www.zohoapis.com/books/v3/settings/openingbalances?organization_id={organization_id} : Update opening balance

Tax Authorities

• GET https://www.zohoapis.com/books/v3/settings/taxauthorities : List tax authorities [US Edition only]
• GET https://www.zohoapis.com/books/v3/settings/taxauthorities/{tax_authority_id} : Get a tax authority [US and CA Edition only]
• PUT https://www.zohoapis.com/books/v3/settings/taxauthorities/{taxauthoritie_id}?organization_id={organization_id} : Update a tax authority [US and CA Edition only]
• POST https://www.zohoapis.com/books/v3/settings/taxauthorities?organization_id={organization_id} : Create a tax authority [US and CA Edition only]

Taxes

• GET https://www.zohoapis.com/books/v3/settings/taxes : List taxes
• DELETE https://www.zohoapis.com/books/v3/settings/taxes/{tax_id}?organization_id={organization_id} : Delete a tax
• GET https://www.zohoapis.com/books/v3/settings/taxes/{taxe_id} : Get a tax
• PUT https://www.zohoapis.com/books/v3/settings/taxes/{taxe_id}?organization_id={organization_id} : Update a tax
• POST https://www.zohoapis.com/books/v3/settings/taxes?organization_id={organization_id} : Create a tax

Tax Exemptions

• GET https://www.zohoapis.com/books/v3/settings/taxexemptions : List tax exemptions [US Edition only]
• DELETE https://www.zohoapis.com/books/v3/settings/taxexemptions/{tax_exemption_id}?organization_id={organization_id} : Delete a tax exemption [US Edition only]
• GET https://www.zohoapis.com/books/v3/settings/taxexemptions/{taxexemption_id} : Get a tax exemption [US Edition only]
• PUT https://www.zohoapis.com/books/v3/settings/taxexemptions/{taxexemption_id}?organization_id={organization_id} : Update a tax exemption [US Edition only]
• POST https://www.zohoapis.com/books/v3/settings/taxexemptions?organization_id={organization_id} : Create a tax exemption [US Edition only]

Tax Groups

• GET https://www.zohoapis.com/books/v3/settings/taxgroups/{taxgroup_id}?organization_id={organization_id} : Get a tax group
• POST https://www.zohoapis.com/books/v3/settings/taxgroups?organization_id={organization_id} : Create a tax group

Share

• GET https://www.zohoapis.com/books/v3/share/paymentlink : Generate payment link

Users

• GET https://www.zohoapis.com/books/v3/users/me : Get current user
• POST https://www.zohoapis.com/books/v3/users/{user_id}/active : Mark user as active
• POST https://www.zohoapis.com/books/v3/users/{user_id}/inactive : Mark user as inactive
• POST https://www.zohoapis.com/books/v3/users/{user_id}/invite : Invite a user
• PUT https://www.zohoapis.com/books/v3/users/{user_id}?organization_id={organization_id} : Update a user
• POST https://www.zohoapis.com/books/v3/users?organization_id={organization_id} : Create a user

Vendor Credits

• GET https://www.zohoapis.com/books/v3/vendorcredits : List vendor credits
• GET https://www.zohoapis.com/books/v3/vendorcredits/refunds : List vendor credit refunds
• DELETE https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_bill_id}/bills/?organization_id={organization_id} : Delete bills credited
• GET https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id} : Get vendor credit
• GET https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/comments : List vendor credit comments & history
• DELETE https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/comments/{comment_id} : Delete a comment
• GET https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/refunds : List refunds of a vendor credit
• DELETE https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/refunds/{refund_id} : Delete vendor credit refund
• GET https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id} : Get vendor credit refund
• POST https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/status/open : Convert Vendor Credit Status to Open
• POST https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/status/void : Void vendor credit
• PUT https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}?organization_id={organization_id} : Update vendor credit
• POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/approve?organization_id={organization_id} : Approve a Vendor credit
• POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/bills?organization_id={organization_id} : Apply credits to a bill
• POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/comments?organization_id={organization_id} : Add a comment to an existing vendor credit
• PUT https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/refunds/{refund_id}?organization_id={organization_id} : Update vendor credit refund
• POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/refunds?organization_id={organization_id} : Refund a vendor credit
• POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/submit?organization_id={organization_id} : Submit a Vendor credit for approval
• POST https://www.zohoapis.com/books/v3/vendorcredits?organization_id={organization_id} : Create a vendor credit

Vendor Payments

• GET https://www.zohoapis.com/books/v3/vendorpayments : List vendor payments
• PUT https://www.zohoapis.com/books/v3/vendorpayments/{paymentId} : Update a vendor payment
• GET https://www.zohoapis.com/books/v3/vendorpayments/{payment_id}?organization_id={organization_id} : Get a vendor payment
• DELETE https://www.zohoapis.com/books/v3/vendorpayments/{vendor_payment_id}?organization_id={organization_id} : Delete a vendor payment
• GET https://www.zohoapis.com/books/v3/vendorpayments/{vendorpayment_id}/refunds : List refunds of a vendor payment
• GET https://www.zohoapis.com/books/v3/vendorpayments/{vendorpayment_id}/refunds/{vendorpayment_refund_id} : Details of a refund
• POST https://www.zohoapis.com/books/v3/vendorpayments/{vendorpayment_id}/refunds?organization_id={organization_id} : Refund an excess vendor payment
• POST https://www.zohoapis.com/books/v3/vendorpayments?organization_id={organization_id} : Create a vendor payment

Zoho Books API FAQs

How do I authenticate with the Zoho Books API?

• Answer: Zoho Books uses OAuth 2.0 for authentication. To access the API, you need to:some text
  1. Register your application in the Zoho Developer Console.
  2. Obtain the Client ID and Client Secret.
  3. Generate an access token and a refresh token by following the OAuth 2.0 flow.
  4. Use the access token in the Authorization header of your API requests.
• Source: OAuth | Zoho Books | API Documentation

What are the rate limits for the Zoho Books API?

• Answer: Zoho Books enforces rate limits based on your subscription plan:some text
  • Free Plan: 1,000 API requests per day.
  • Standard Plan: 2,000 API requests per day.
  • Professional Plan: 5,000 API requests per day.
  • Premium Plan: 10,000 API requests per day.
  • Elite Plan: 10,000 API requests per day.
  • Ultimate Plan: 10,000 API requests per day.
  • Additionally, there is a limit of 100 requests per minute per organization.
• Source: Introduction | Zoho Books | API Documentation

How can I retrieve a list of invoices using the Zoho Books API?

Answer: To retrieve a list of invoices, make a GET request to the /invoices endpoint:
bash
GET https://www.zohoapis.com/books/v3/invoices?organization_id=YOUR_ORG_ID

• Replace YOUR_ORG_ID with your actual organization ID. Ensure you include the Authorization header with your access token.
• Source: Invoices | Zoho Books | API Documentation

Does the Zoho Books API support webhooks for real-time updates?

• Answer: As of the latest available information, Zoho Books does not natively support webhooks. However, you can use the API to poll for changes or integrate with third-party services that provide webhook functionality to achieve similar outcomes.

Can I create custom fields for items using the Zoho Books API?

• Answer: Yes, you can create custom fields for items. When creating or updating an item, include the custom_fields array in your request payload, specifying the customfield_id and its corresponding value.
• Source: Items | Zoho Books | API Documentation

Get Started with Zoho Books API Integration

For quick and seamless integration with Zohobooks API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Zohobooks API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 Zohobooks API.‍

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

Rippling is a versatile software platform that revolutionizes human resources and business operations management. It offers a comprehensive suite of tools designed to streamline and automate various aspects of employee management, making it an essential asset for businesses looking to enhance efficiency. Key functionalities include payroll management, which automates payroll processing, ensuring compliance and accuracy with tax calculations and filings across federal, state, and local agencies. Additionally, Rippling supports global payroll, enabling businesses to seamlessly pay employees worldwide, thus catering to the needs of international operations.

Beyond payroll, Rippling excels in HR management by providing tools for managing employee information, benefits administration, and ensuring compliance with HR regulations. Its IT management features allow businesses to manage employee devices, apps, and access permissions, effectively integrating IT management with HR processes. Furthermore, Rippling automates onboarding and offboarding processes, ensuring efficient setup and removal of employee access and tools. The platform also offers time tracking and attendance management features, helping businesses monitor and manage employee work hours efficiently. With its integrated solution, Rippling significantly streamlines administrative tasks and enhances operational efficiency in HR and IT management. For developers and businesses looking to extend these capabilities, the Rippling API offers seamless integration options, making it a powerful tool for customized business solutions.

Key highlights of Rippling APIs

• Automation of HR Functions
  • Automates tasks like employee onboarding, benefits management, and payroll processing, saving time and reducing errors.
• Centralized Benefits Management
  • Allows HR teams to manage employee benefits, such as health insurance and retirement plans, in one system, improving efficiency.
• Data Synchronization
  • Ensures up-to-date and consistent employee information across different systems.
• REST API Integration
  • Enables developers to integrate Rippling with other systems, allowing for customization to meet specific business needs.
• Seamless HR and IT Integration
  • Supports integration of HR and IT processes, enhancing employee experience by making processes faster and more efficient.
• Third-Party Integrations
  • Can be integrated with applications like 15Five to facilitate data exchange and improve workflow efficiency.

Rippling API Endpoints

Candidate Management

• POST https://api.rippling.com/platform/api/ats_candidates/push_candidate : Push New Candidate to Rippling Onboarding

Company Information

• GET https://api.rippling.com/platform/api/companies/current : GET Current Company
• GET https://api.rippling.com/platform/api/company_activity : GET Company Activity
• GET https://api.rippling.com/platform/api/company_leave_types : GET Company Leave Types
• GET https://api.rippling.com/platform/api/levels : GET Company Levels

Employee Management

• GET https://api.rippling.com/platform/api/employees : Get Active Employees List
• GET https://api.rippling.com/platform/api/employees/include_terminated : Get Active and Terminated Employees
• GET https://api.rippling.com/platform/api/employees/{employeeId} : Get Employee Information

Group Management

• POST https://api.rippling.com/platform/api/groups : Create a Generic Group
• PUT https://api.rippling.com/platform/api/groups/{groupId} : Update Group in Rippling

Leave Management

• GET https://api.rippling.com/platform/api/leave_balances : Retrieve Employee Leave Balances
• GET https://api.rippling.com/platform/api/leave_balances/{role} : Retrieve Leave Balances for a Given Role
• GET https://api.rippling.com/platform/api/leave_requests : Retrieve Current Leave Requests
• PATCH https://api.rippling.com/platform/api/leave_requests/{id} : Update Leave Request
• POST https://api.rippling.com/platform/api/leave_requests/{id}/process : Approve or Decline a Leave Request

Miscellaneous

• GET https://api.rippling.com/platform/api/custom_fields : GET Custom Fields
• GET https://api.rippling.com/platform/api/departments : GET Departments
• POST https://api.rippling.com/platform/api/mark_app_installed : Mark App as Installed in Rippling
• GET https://api.rippling.com/platform/api/me : GET Current User Information
• GET https://api.rippling.com/platform/api/saml/idp_metadata : Get SAML Metadata
• GET https://api.rippling.com/platform/api/teams : Get Teams List
• GET https://api.rippling.com/platform/api/work_locations : Get Work Locations

‍

Rippling API FAQs

1. How do I access the Rippling API?

• Answer: To access the Rippling API, you need to generate an API token. Navigate to the 'API Tokens' section in your Rippling account settings, create a new token, and securely store it, as it will not be displayed again.
• Source: API Tokens - Rippling

‍

2. What authentication method does the Rippling API use?

• Answer: The Rippling API uses token-based authentication. Include the API token in the 'Authorization' header of your HTTP requests, formatted as 'Bearer YOUR_API_TOKEN'.
• Source: Rippling Platform API

‍

3. Are there rate limits for the Rippling API?

• Answer: Yes, the Rippling API enforces rate limits to ensure fair usage. While specific limits are not publicly documented, it's recommended to implement error handling for potential 429 Too Many Requests responses.
• Source: Rippling API - Developer docs, APIs, SDKs, and auth.

‍

4. Can I retrieve employee data using the Rippling API?

• Answer: Yes, you can retrieve employee data by making a GET request to the '/employees' endpoint. Ensure you have the necessary permissions and that your API token has access to the required scopes.
• Source: Rippling Platform API

‍

5. Does the Rippling API support webhooks?

• Answer: Yes, the Rippling API supports webhooks, allowing you to receive real-time notifications for specific events. You can configure webhooks to trigger on events such as employee onboarding or offboarding.
• Source: Rippling API - Developer docs, APIs, SDKs, and auth.

‍

Get Started with Rippling API Integration

For quick and seamless integration with Rippling API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Rippling API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 Rippling API.‍

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

‍

Personio is a comprehensive cloud-based HR software tailored specifically for small and medium-sized enterprises (SMEs) aiming to streamline and automate their HR processes. This robust platform offers a suite of tools designed to enhance HR management, recruitment, performance management, and time management. By centralizing employee data, Personio enables businesses to efficiently track attendance, manage payroll, oversee job postings, and handle applicant tracking. Additionally, it facilitates performance reviews and the management of working hours and leave requests, making it an invaluable asset for companies seeking to digitize their HR operations and minimize administrative burdens.

One of the standout features of Personio is its ability to integrate seamlessly with other systems through the Personio API. This integration capability allows businesses to connect Personio with various third-party applications, enhancing the software's functionality and ensuring a smooth flow of data across platforms. By leveraging the Personio API, companies can customize their HR processes to better fit their unique needs, further optimizing their HR management and operational efficiency.

Key highlights of Personio APIs

• 1. Easy Data Access:
  • Seamlessly read and write company, census, and payroll data, including deductions and benefits contributions.
• 2. Automation:
  • Supports automated data transfer to streamline administrative processes and reduce manual data entry.
• 3. Custom Integration:
  • Open API allows for easy integration with other software solutions, connecting existing systems with Personio.
• 4. Third-Party Integrations:
  • Integrates with applications like Xero and DATEV for effortless data transfer and enhanced HR processes.
• 5. Unified API via Merge:
  • Connects products with Personio and other applications to help businesses close more deals and retain customers.
• 6. Scalable:
  • Designed to support companies with 10 to 2000 employees, offering scalability as business needs grow.
• 7. Developer-Friendly:
  • Enables the creation of automations, scripts, and applications to enhance HR processes.

Personio API Endpoints

Absence Periods

• POST https://api.personio.de/v1/company/absence-periods : Create an Absence Period
• DELETE https://api.personio.de/v1/company/absence-periods/{id} : Delete Absence Period by ID

Attendances

• POST https://api.personio.de/v1/company/attendances : Create an Attendance
• GET https://api.personio.de/v1/company/attendances/projects : List Projects
• PATCH https://api.personio.de/v1/company/attendances/projects/{id} : Update Project by ID
• PATCH https://api.personio.de/v1/company/attendances/{id} : Update Attendance by ID

Custom Reports

• GET https://api.personio.de/v1/company/custom-reports/columns : List Custom Report Column Labels
• GET https://api.personio.de/v1/company/custom-reports/reports : List Custom Reports
• GET https://api.personio.de/v1/company/custom-reports/reports/{report_id} : Get Custom Report by ID

Documents

• GET https://api.personio.de/v1/company/document-categories : List Document Categories
• POST https://api.personio.de/v1/company/documents : Upload Document for Company Employees

Employees

• GET https://api.personio.de/v1/company/employees : List Company Employees
• GET https://api.personio.de/v1/company/employees/attributes : List Allowed Employee Attributes
• GET https://api.personio.de/v1/company/employees/custom-attributes : List Allowed Custom Attributes
• GET https://api.personio.de/v1/company/employees/{employee_id} : Get Employee by ID
• GET https://api.personio.de/v1/company/employees/{employee_id}/absences/balance : Get Absence Balance for Employee
• GET https://api.personio.de/v1/company/employees/{employee_id}/profile-picture/{width} : Get Employee Profile Picture

Time-Off

• GET https://api.personio.de/v1/company/time-off-types : List Time-Off Types
• POST https://api.personio.de/v1/company/time-offs : Create a Time-Off
• DELETE https://api.personio.de/v1/company/time-offs/{id} : Delete Time-Off by ID

Recruiting

• POST https://api.personio.de/v1/recruiting/applications : Create Applications in Personio
• POST https://api.personio.de/v1/recruiting/applications/documents : Upload Documents to Applications

Open Positions

• GET https://api.personio.de/xml : Retrieve Open Positions

Personio API FAQs

How do I generate API credentials in Personio?

• Answer: To generate API credentials in Personio:some text
  1. Navigate to Settings > Integrations > API Credentials.
  2. Click on Generate new credentials.
  3. Select the desired scopes and readable attributes for the API key.
  4. Save the generated client_id and client_secret securely.
• Source: Generate and manage API credentials - Personio

What authentication method does the Personio API use?

• Answer: The Personio API uses OAuth 2.0 for authentication. After obtaining your client_id and client_secret, you can request an access token by making a POST request to the authentication endpoint. This token must be included in the Authorization header of your subsequent API requests.
• Source: Get started with Personio API - Personio Developer Hub

Are there rate limits for the Personio API?

• Answer: Yes, Personio enforces rate limits to ensure fair usage:some text
  • Documents and Applications Endpoints: Limited to 20 requests per 60 seconds per company.
  • Other Endpoints: Specific rate limits are not publicly documented; it's recommended to implement error handling for potential 429 Too Many Requests responses.
• Source: Introduction - Personio Developer Hub

Can I retrieve employee data using the Personio API?

• Answer: Yes, you can retrieve employee data by making a GET request to the /v1/company/employees endpoint. Ensure that the desired employee attributes are whitelisted in your API credentials settings to access them via the API.
• Source: List Employees - Personio Developer Hub

Does the Personio API support webhooks?

• Answer: Yes, Personio supports webhooks for specific events, such as when an employee's profile is created, updated, or deleted. You can configure webhooks to receive real-time notifications for these events.
• Source: Personio Developer Hub

‍

Get Started with Personio API Integration

For quick and seamless integration with Personio API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Personio API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 Personio API.‍

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

HubSpot is a cloud-based software platform designed to facilitate business growth by offering an integrated suite of tools for marketing, sales, customer service, and customer relationship management (CRM). Known for its user-friendly interface and robust integration capabilities, HubSpot provides businesses with the resources needed to enhance their operations and customer interactions. The platform is particularly popular among companies focusing on digital marketing and customer engagement strategies, making it a versatile solution for businesses of all sizes and industries.

HubSpot's comprehensive offerings include the Marketing Hub, which aids businesses in attracting visitors, converting leads, and closing customers through features like email marketing, social media management, and SEO analytics. The Sales Hub empowers sales teams to manage pipelines and automate tasks efficiently, while the Service Hub focuses on improving customer satisfaction with tools for ticketing and feedback management. Additionally, HubSpot's CRM offers a centralized database for tracking and nurturing leads, and the CMS Hub provides an intuitive content management system for website creation and optimization.

Key highlights of Hubspot APIs

• 1. Easy Data Access:
  • The HubSpot API facilitates seamless access to data, enhancing accuracy and efficiency in business operations.
• 2. Automation:
  • Supports marketing automation, sales enablement, and customer service, streamlining processes and increasing productivity.
• 3. Custom Integration:
  • Enables seamless data exchange between HubSpot and other systems, improving overall productivity.
• 4. Real-Time Sync:
  • Utilizes webhooks for prompt notifications of changes, ensuring up-to-date data synchronization.
• 5. Scalable:
  • Capable of handling up to 150 requests per second, accommodating growing business needs.
• 6. Developer-Friendly:
  • Extensive documentation and support make it accessible for developers to implement and manage.
• 7. Global Support:
  • Implied by HubSpot's international presence, offering assistance across different regions.
• 8. Error Handling and Logging:
  • Standard features included to manage and troubleshoot integration issues effectively.
• 9. Rate Limiting:
  • Ensures fair usage and prevents abuse by limiting the number of requests per second.
• 10. Version Control:
  • Maintains stability and compatibility across different API versions.
• 11. Data Transformation:
  • Managed within integration logic to suit specific business requirements.
• 12. Webhook Support:
  • Allows for event subscriptions, enhancing real-time data handling capabilities.
• 13. Detailed Analytics and Reporting:
  • Likely includes features for comprehensive data insights to aid decision-making.
• 14. Sandbox Environment:
  • A 60-day testing environment is available for development and experimentation.

Hubspot API Endpoints

Imports

• POST /crm/v3/imports/ : Start a New Import
• GET https://api.hubapi.com/crm/v3/imports/ : Get Active Imports
• GET https://api.hubapi.com/crm/v3/imports/{importId} : Get Import Information
• POST https://api.hubapi.com/crm/v3/imports/{importId}/cancel : Cancel an Active Import
• GET https://api.hubapi.com/crm/v3/imports/{importId}/errors : Get Import Errors

CRM Object Schemas

• GET https://api.hubapi.com/crm-object-schemas/v3/schemas : Get All CRM Object Schemas
• DELETE https://api.hubapi.com/crm-object-schemas/v3/schemas/ : Delete a Schema
• PATCH https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} : Update Object Schema
• POST https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType}/associations : Create an Association Between Object Types
• DELETE https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType}/associations/{associationIdentifier} : Remove an Association from a Schema
• DELETE https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType}/purge : Delete CRM Object Schema

Exports

• POST https://api.hubapi.com/crm/v3/exports/export/async : Start an Export of CRM Data
• GET https://api.hubapi.com/crm/v3/exports/export/async/tasks/{taskId}/status : Get Export Task Status

Calling Extensions

• POST https://api.hubapi.com/crm/v3/extensions/calling/recordings/ready : Mark Recording as Ready for Transcription
• POST https://api.hubapi.com/crm/v3/extensions/calling/{appId}/settings : Configure a Calling Extension
• PATCH https://api.hubapi.com/crm/v3/extensions/calling/{appId}/settings/recording : Update Calling App's Recording Settings

Cards

• GET https://api.hubapi.com/crm/v3/extensions/cards-dev/sample-response : Get Sample Card Detail Response
• GET https://api.hubapi.com/crm/v3/extensions/cards-dev/{appId} : Get All Cards for a Given App
• DELETE https://api.hubapi.com/crm/v3/extensions/cards-dev/{appId}/{cardId} : Delete Card Definition

Video Conferencing

• DELETE https://api.hubapi.com/crm/v3/extensions/videoconferencing/settings/{appId} : Delete Video Conference Application Settings

Lists

• POST https://api.hubapi.com/crm/v3/lists/ : Create List
• GET https://api.hubapi.com/crm/v3/lists/folders : Retrieve Folder with Child Nodes
• PUT https://api.hubapi.com/crm/v3/lists/folders/move-list : Move List to Folder
• DELETE https://api.hubapi.com/crm/v3/lists/folders/{folderId} : Delete CRM Folder
• PUT https://api.hubapi.com/crm/v3/lists/folders/{folderId}/move/{newParentFolderId} : Move a Folder in CRM
• PUT https://api.hubapi.com/crm/v3/lists/folders/{folderId}/rename : Rename a Folder in CRM
• GET https://api.hubapi.com/crm/v3/lists/idmapping : Translate Legacy List Id to Modern List Id
• GET https://api.hubapi.com/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName} : Fetch List by Name
• GET https://api.hubapi.com/crm/v3/lists/records/{objectTypeId}/{recordId}/memberships : Get Lists Record is Member Of
• POST https://api.hubapi.com/crm/v3/lists/search : Search Lists by Name or Page Through All Lists
• GET https://api.hubapi.com/crm/v3/lists/{listId} : Fetch List by ID
• DELETE https://api.hubapi.com/crm/v3/lists/{listId}/memberships : Delete All Records from a List
• PUT https://api.hubapi.com/crm/v3/lists/{listId}/memberships/add : Add Records to a List
• PUT https://api.hubapi.com/crm/v3/lists/{listId}/memberships/add-and-remove : Add and/or Remove Records from a List
• PUT https://api.hubapi.com/crm/v3/lists/{listId}/memberships/add-from/{sourceListId} : Add All Records from a Source List to a Destination List
• GET https://api.hubapi.com/crm/v3/lists/{listId}/memberships/join-order : Fetch List Memberships Ordered by Added to List Date
• PUT https://api.hubapi.com/crm/v3/lists/{listId}/memberships/remove : Remove Records from a List
• PUT https://api.hubapi.com/crm/v3/lists/{listId}/restore : Restore a Deleted List
• PUT https://api.hubapi.com/crm/v3/lists/{listId}/update-list-filters : Update List Filter Definition
• PUT https://api.hubapi.com/crm/v3/lists/{listId}/update-list-name : Update List Name

CRM Objects

• GET https://api.hubapi.com/crm/v3/objects/calls : Read a Page of Calls
• POST https://api.hubapi.com/crm/v3/objects/calls/batch/archive : Archive a Batch of Calls by ID
• POST https://api.hubapi.com/crm/v3/objects/calls/batch/create : Create a Batch of Calls
• POST https://api.hubapi.com/crm/v3/objects/calls/batch/read : Read a Batch of Calls by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/calls/batch/update : Update a Batch of Calls by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/calls/batch/upsert : Create or Update a Batch of Calls by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/calls/search : Search Calls in CRM
• PATCH https://api.hubapi.com/crm/v3/objects/calls/{callId} : Partial Update of CRM Call Object
• GET https://api.hubapi.com/crm/v3/objects/carts : Read a Page of Carts
• POST https://api.hubapi.com/crm/v3/objects/carts/batch/archive : Archive a Batch of Carts by ID
• POST https://api.hubapi.com/crm/v3/objects/carts/batch/create : Create a Batch of Carts
• POST https://api.hubapi.com/crm/v3/objects/carts/batch/read : Read a Batch of Carts by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/carts/batch/update : Update a Batch of Carts by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/carts/batch/upsert : Create or Update a Batch of Carts by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/carts/search : Search Carts in CRM
• DELETE https://api.hubapi.com/crm/v3/objects/carts/{cartId} : Delete Cart Object
• GET https://api.hubapi.com/crm/v3/objects/commerce_payments : List Commerce Payments
• POST https://api.hubapi.com/crm/v3/objects/commerce_payments/batch/read : Read a Batch of Commerce Payments by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/commerce_payments/search : Search Commerce Payments
• GET https://api.hubapi.com/crm/v3/objects/commerce_payments/{commercePaymentId} : Get Commerce Payment Details
• POST https://api.hubapi.com/crm/v3/objects/communications : Create a Communication
• POST https://api.hubapi.com/crm/v3/objects/communications/batch/archive : Archive a Batch of Communications by ID
• POST https://api.hubapi.com/crm/v3/objects/communications/batch/create : Create a Batch of Communications
• POST https://api.hubapi.com/crm/v3/objects/communications/batch/read : Read a Batch of Communications by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/communications/batch/update : Update a Batch of Communications by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/communications/batch/upsert : Create or Update a Batch of Communications by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/communications/search : Search Communications in CRM
• PATCH https://api.hubapi.com/crm/v3/objects/communications/{communicationId} : Partial Update of Communication Object
• POST https://api.hubapi.com/crm/v3/objects/companies : Create a Company
• POST https://api.hubapi.com/crm/v3/objects/companies/batch/archive : Archive a Batch of Companies by ID
• POST https://api.hubapi.com/crm/v3/objects/companies/batch/create : Create a Batch of Companies
• POST https://api.hubapi.com/crm/v3/objects/companies/batch/read : Read a Batch of Companies by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/companies/batch/update : Update a Batch of Companies by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/companies/batch/upsert : Create or Update a Batch of Companies by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/companies/merge : Merge Two Companies with Same Type
• POST https://api.hubapi.com/crm/v3/objects/companies/search : Search Companies in CRM
• DELETE https://api.hubapi.com/crm/v3/objects/companies/{companyId} : Delete a Company Object
• POST https://api.hubapi.com/crm/v3/objects/contacts : Create a Contact in HubSpot CRM
• POST https://api.hubapi.com/crm/v3/objects/contacts/batch/archive : Archive a Batch of Contacts by ID
• POST https://api.hubapi.com/crm/v3/objects/contacts/batch/create : Create a Batch of Contacts
• POST https://api.hubapi.com/crm/v3/objects/contacts/batch/read : Read a Batch of Contacts by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/contacts/batch/update : Update a Batch of Contacts by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/contacts/batch/upsert : Create or Update a Batch of Contacts by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/contacts/gdpr-delete : GDPR Delete Contact
• POST https://api.hubapi.com/crm/v3/objects/contacts/merge : Merge Two Contacts with Same Type
• POST https://api.hubapi.com/crm/v3/objects/contacts/search : Search Contacts in CRM
• DELETE https://api.hubapi.com/crm/v3/objects/contacts/{contactId} : Delete Contact by ID
• GET https://api.hubapi.com/crm/v3/objects/deals : Read a Page of Deals
• POST https://api.hubapi.com/crm/v3/objects/deals/batch/archive : Archive a Batch of Deals by ID
• POST https://api.hubapi.com/crm/v3/objects/deals/batch/create : Create a Batch of Deals
• POST https://api.hubapi.com/crm/v3/objects/deals/batch/read : Read a Batch of Deals by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/deals/batch/update : Update a Batch of Deals by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/deals/batch/upsert : Create or Update a Batch of Deals by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/deals/merge : Merge Two Deals with Same Type
• POST https://api.hubapi.com/crm/v3/objects/deals/search : Search Deals in CRM
• POST https://api.hubapi.com/crm/v3/objects/deals/splits/batch/read : Read a Batch of Deal Split Objects by Deal Object Internal ID
• POST https://api.hubapi.com/crm/v3/objects/deals/splits/batch/upsert : Create or Replace Deal Splits for Deals
• DELETE https://api.hubapi.com/crm/v3/objects/deals/{dealId} : Delete a Deal Object
• POST https://api.hubapi.com/crm/v3/objects/discounts : Create a Discount
• POST https://api.hubapi.com/crm/v3/objects/discounts/batch/archive : Archive a Batch of Discounts by ID
• POST https://api.hubapi.com/crm/v3/objects/discounts/batch/create : Create a Batch of Discounts
• POST https://api.hubapi.com/crm/v3/objects/discounts/batch/read : Read a Batch of Discounts by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/discounts/batch/update : Update a Batch of Discounts by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/discounts/batch/upsert : Create or Update a Batch of Discounts by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/discounts/search : Search Discounts in CRM
• PATCH https://api.hubapi.com/crm/v3/objects/discounts/{discountId} : Partial Update of Discount Object
• GET https://api.hubapi.com/crm/v3/objects/emails : Read a Page of Emails
• POST https://api.hubapi.com/crm/v3/objects/emails/batch/archive : Archive a Batch of Emails by ID
• POST https://api.hubapi.com/crm/v3/objects/emails/batch/create : Create a Batch of Emails
• POST https://api.hubapi.com/crm/v3/objects/emails/batch/read : Read a Batch of Emails by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/emails/batch/update : Update a Batch of Emails by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/emails/batch/upsert : Create or Update a Batch of Emails by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/emails/search : Search Emails in CRM
• GET https://api.hubapi.com/crm/v3/objects/emails/{emailId} : Get Email Object Details
• GET https://api.hubapi.com/crm/v3/objects/feedback_submissions : Get Feedback Submissions
• POST https://api.hubapi.com/crm/v3/objects/feedback_submissions/batch/read : Read a Batch of Feedback Submissions by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/feedback_submissions/search : Search Feedback Submissions
• GET https://api.hubapi.com/crm/v3/objects/feedback_submissions/{feedbackSubmissionId} : Get Feedback Submission Details
• POST https://api.hubapi.com/crm/v3/objects/fees : Create a Fee with Given Properties
• POST https://api.hubapi.com/crm/v3/objects/fees/batch/archive : Archive a Batch of Fees by ID
• POST https://api.hubapi.com/crm/v3/objects/fees/batch/create : Create a Batch of Fees
• POST https://api.hubapi.com/crm/v3/objects/fees/batch/read : Read a Batch of Fees by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/fees/batch/update : Update a Batch of Fees by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/fees/batch/upsert : Create or Update a Batch of Fees by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/fees/search : Search Fees in CRM
• GET https://api.hubapi.com/crm/v3/objects/fees/{feeId} : Get Fee Object Details
• GET https://api.hubapi.com/crm/v3/objects/goal_targets : Read a Page of Goal Targets
• POST https://api.hubapi.com/crm/v3/objects/goal_targets/batch/read : Read a Batch of Goal Targets by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/goal_targets/search : Search Goal Targets
• GET https://api.hubapi.com/crm/v3/objects/goal_targets/{goalTargetId} : Read Goal Target Object
• GET https://api.hubapi.com/crm/v3/objects/invoices : Read a Page of Invoices
• POST https://api.hubapi.com/crm/v3/objects/invoices/batch/read : Read a Batch of Invoices by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/invoices/search : Search Invoices in CRM
• GET https://api.hubapi.com/crm/v3/objects/invoices/{invoiceId} : Get Invoice Details
• POST https://api.hubapi.com/crm/v3/objects/leads : Create a Lead
• POST https://api.hubapi.com/crm/v3/objects/leads/batch/archive : Archive a Batch of Leads by ID
• POST https://api.hubapi.com/crm/v3/objects/leads/batch/create : Create a Batch of Leads
• POST https://api.hubapi.com/crm/v3/objects/leads/batch/read : Read a Batch of Leads by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/leads/batch/update : Update a Batch of Leads by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/leads/batch/upsert : Create or Update a Batch of Leads by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/leads/search : Search Leads in CRM
• DELETE https://api.hubapi.com/crm/v3/objects/leads/{leadsId} : Delete Lead Object
• POST https://api.hubapi.com/crm/v3/objects/line_items : Create Line Item
• POST https://api.hubapi.com/crm/v3/objects/line_items/batch/archive : Archive a Batch of Line Items by ID
• POST https://api.hubapi.com/crm/v3/objects/line_items/batch/create : Create a Batch of Line Items
• POST https://api.hubapi.com/crm/v3/objects/line_items/batch/read : Read a Batch of Line Items by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/line_items/batch/update : Update a Batch of Line Items by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/line_items/batch/upsert : Create or Update a Batch of Line Items by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/line_items/search : Search Line Items in CRM
• PATCH https://api.hubapi.com/crm/v3/objects/line_items/{lineItemId} : Partial Update of Line Item Object
• GET https://api.hubapi.com/crm/v3/objects/meetings : Read a Page of Meetings
• POST https://api.hubapi.com/crm/v3/objects/meetings/batch/archive : Archive a Batch of Meetings by ID
• POST https://api.hubapi.com/crm/v3/objects/meetings/batch/create : Create a Batch of Meetings
• POST https://api.hubapi.com/crm/v3/objects/meetings/batch/read : Read a Batch of Meetings by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/meetings/batch/update : Update a Batch of Meetings by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/meetings/batch/upsert : Create or Update a Batch of Meetings by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/meetings/search : Search Meetings in CRM
• DELETE https://api.hubapi.com/crm/v3/objects/meetings/{meetingId} : Archive Meeting Object
• POST https://api.hubapi.com/crm/v3/objects/notes : Create a Note in HubSpot CRM
• POST https://api.hubapi.com/crm/v3/objects/notes/batch/archive : Archive a Batch of Notes by ID
• POST https://api.hubapi.com/crm/v3/objects/notes/batch/create : Create a Batch of Notes
• POST https://api.hubapi.com/crm/v3/objects/notes/batch/read : Read a Batch of Notes by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/notes/batch/update : Update a Batch of Notes by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/notes/batch/upsert : Create or Update a Batch of Notes by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/notes/search : Search CRM Notes
• PATCH https://api.hubapi.com/crm/v3/objects/notes/{noteId} : Partial Update of CRM Note Object
• GET https://api.hubapi.com/crm/v3/objects/orders : Read a Page of Orders
• POST https://api.hubapi.com/crm/v3/objects/orders/batch/archive : Archive a Batch of Orders by ID
• POST https://api.hubapi.com/crm/v3/objects/orders/batch/create : Create a Batch of Orders
• POST https://api.hubapi.com/crm/v3/objects/orders/batch/read : Read a Batch of Orders by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/orders/batch/update : Update a Batch of Orders by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/orders/batch/upsert : Create or Update a Batch of Orders by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/orders/search : Search Orders in CRM
• GET https://api.hubapi.com/crm/v3/objects/orders/{orderId} : Read Order Object by ID
• GET https://api.hubapi.com/crm/v3/objects/postal_mail : Read a Page of Postal Mail
• POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/archive : Archive a Batch of Postal Mail by ID
• POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/create : Create a Batch of Postal Mail
• POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/read : Read a Batch of Postal Mail by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/update : Update a Batch of Postal Mail by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/upsert : Create or Update a Batch of Postal Mail by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/postal_mail/search : Search Postal Mail Objects in CRM
• DELETE https://api.hubapi.com/crm/v3/objects/postal_mail/{postalMailId} : Delete Postal Mail Object
• POST https://api.hubapi.com/crm/v3/objects/products : Create a Product
• POST https://api.hubapi.com/crm/v3/objects/products/batch/archive : Archive a Batch of Products by ID
• POST https://api.hubapi.com/crm/v3/objects/products/batch/create : Create a Batch of Products
• POST https://api.hubapi.com/crm/v3/objects/products/batch/read : Read a Batch of Products by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/products/batch/update : Update a Batch of Products by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/products/batch/upsert : Create or Update a Batch of Products by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/products/search : Search Products in CRM
• GET https://api.hubapi.com/crm/v3/objects/products/{productId} : Get Product Details by Product ID
• GET https://api.hubapi.com/crm/v3/objects/quotes : Read a Page of Quotes
• POST https://api.hubapi.com/crm/v3/objects/quotes/batch/archive : Archive a Batch of Quotes by ID
• POST https://api.hubapi.com/crm/v3/objects/quotes/batch/create : Create a Batch of Quotes
• POST https://api.hubapi.com/crm/v3/objects/quotes/batch/read : Read a Batch of Quotes by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/quotes/batch/update : Update a Batch of Quotes by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/quotes/batch/upsert : Create or Update a Batch of Quotes by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/quotes/search : Search Quotes in CRM
• GET https://api.hubapi.com/crm/v3/objects/quotes/{quoteId} : Get Quote Details by Quote ID
• GET https://api.hubapi.com/crm/v3/objects/subscriptions : Read a Page of Subscriptions
• POST https://api.hubapi.com/crm/v3/objects/subscriptions/batch/read : Read a Batch of Subscriptions by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/subscriptions/search : Search Subscriptions in CRM
• GET https://api.hubapi.com/crm/v3/objects/subscriptions/{subscriptionId} : Get Subscription Details
• GET https://api.hubapi.com/crm/v3/objects/tasks : Read a Page of Tasks
• POST https://api.hubapi.com/crm/v3/objects/tasks/batch/archive : Archive a Batch of Tasks by ID
• POST https://api.hubapi.com/crm/v3/objects/tasks/batch/create : Create a Batch of Tasks
• POST https://api.hubapi.com/crm/v3/objects/tasks/batch/read : Read a Batch of Tasks by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/tasks/batch/update : Update a Batch of Tasks by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/tasks/batch/upsert : Create or Update a Batch of Tasks by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/tasks/search : Search CRM Tasks
• DELETE https://api.hubapi.com/crm/v3/objects/tasks/{taskId} : Delete Task Object
• GET https://api.hubapi.com/crm/v3/objects/taxes : Read a Page of Taxes
• POST https://api.hubapi.com/crm/v3/objects/taxes/batch/archive : Archive a Batch of Taxes by ID
• POST https://api.hubapi.com/crm/v3/objects/taxes/batch/create : Create a Batch of Taxes
• POST https://api.hubapi.com/crm/v3/objects/taxes/batch/read : Read a Batch of Taxes by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/taxes/batch/update : Update a Batch of Taxes by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/taxes/batch/upsert : Create or Update a Batch of Taxes by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/taxes/search : Search Taxes in CRM
• DELETE https://api.hubapi.com/crm/v3/objects/taxes/{taxId} : Delete Tax Object
• GET https://api.hubapi.com/crm/v3/objects/tickets : Read a Page of Tickets
• POST https://api.hubapi.com/crm/v3/objects/tickets/batch/archive : Archive a Batch of Tickets by ID
• POST https://api.hubapi.com/crm/v3/objects/tickets/batch/create : Create a Batch of Tickets
• POST https://api.hubapi.com/crm/v3/objects/tickets/batch/read : Read a Batch of Tickets by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/tickets/batch/update : Update a Batch of Tickets by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/tickets/batch/upsert : Create or Update a Batch of Tickets by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/tickets/merge : Merge Two Tickets with Same Type
• POST https://api.hubapi.com/crm/v3/objects/tickets/search : Search CRM Tickets
• GET https://api.hubapi.com/crm/v3/objects/tickets/{ticketId} : Get Ticket Details by Ticket ID
• GET https://api.hubapi.com/crm/v3/objects/{objectType} : Read a Page of CRM Objects
• POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/archive : Archive a Batch of CRM Objects by ID
• POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/create : Create a Batch of CRM Objects
• POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/read : Read a Batch of CRM Objects by Internal ID or Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/update : Update a Batch of CRM Objects
• POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/upsert : Create or Update a Batch of CRM Objects by Unique Property Values
• POST https://api.hubapi.com/crm/v3/objects/{objectType}/search : Search CRM Objects
• PATCH https://api.hubapi.com/crm/v3/objects/{objectType}/{objectId} : Partial Update of CRM Object

CRM Owners

• GET https://api.hubapi.com/crm/v3/owners/ : Get a Page of CRM Owners
• GET https://api.hubapi.com/crm/v3/owners/{ownerId} : Read an Owner by Given ID or UserID

Pipelines

• GET https://api.hubapi.com/crm/v3/pipelines/{objectType} : Retrieve All Pipelines for a Specified Object Type
• PUT https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId} : Replace a Pipeline
• GET https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/audit : Get Pipeline Audit
• GET https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages : Get Pipeline Stages
• DELETE https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} : Delete a Pipeline Stage
• GET https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit : Get Audit of Pipeline Stage Changes

Properties

• POST https://api.hubapi.com/crm/v3/properties/{objectType} : Create a Property for a Specified Object Type
• POST https://api.hubapi.com/crm/v3/properties/{objectType}/batch/archive : Archive a Batch of Properties
• POST https://api.hubapi.com/crm/v3/properties/{objectType}/batch/create : Create a Batch of Properties
• POST https://api.hubapi.com/crm/v3/properties/{objectType}/batch/read : Read a Batch of Properties
• GET https://api.hubapi.com/crm/v3/properties/{objectType}/groups : Read All Property Groups for Specified Object Type
• PATCH https://api.hubapi.com/crm/v3/properties/{objectType}/groups/{groupName} : Update a Property Group
• DELETE https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} : Archive a Property

Associations

• GET https://api.hubapi.com/crm/v4/associations/definitions/configurations/all : Get All User Configurations
• GET https://api.hubapi.com/crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType} : Get User Configurations on Association Definitions
• POST https://api.hubapi.com/crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create : Batch Create User Configurations Between Two Object Types
• POST https://api.hubapi.com/crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge : Batch Delete User Configurations Between Two Object Types
• POST https://api.hubapi.com/crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update : Batch Update User Configurations Between Two Object Types
• POST https://api.hubapi.com/crm/v4/associations/usage/high-usage-report/{userId} : Generate High Usage Report for User
• POST https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default : Create Default Associations
• POST https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive : Delete Specific Association Labels
• POST https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read : Batch Read Associations for CRM Objects
• GET https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/labels : Get Association Types Between Object Types
• DELETE https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/labels/{associationTypeId} : Delete Association Definition
• PUT https://api.hubapi.com/crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId} : Create Default Association Between Two Object Types
• GET https://api.hubapi.com/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType} : List All Associations of an Object by Object Type
• DELETE https://api.hubapi.com/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId} : Delete Associations Between Two Records

Timeline Events

• POST https://api.hubapi.com/integrators/timeline/v3/events : Create a Single Timeline Event
• POST https://api.hubapi.com/integrators/timeline/v3/events/batch/create : Create Multiple Timeline Events
• GET https://api.hubapi.com/integrators/timeline/v3/events/{eventTemplateId}/{eventId} : Get Event Details
• GET https://api.hubapi.com/integrators/timeline/v3/events/{eventTemplateId}/{eventId}/detail : Get Event Detail Template Rendered
• GET https://api.hubapi.com/integrators/timeline/v3/events/{eventTemplateId}/{eventId}/render : Render Event Template as HTML
• POST https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates : Create Event Template for App
• DELETE https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId} : Delete Event Template for App
• POST https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens : Add Token to Event Template
• DELETE https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens/{tokenName} : Remove Token from Event Template

‍

HubSpot API FAQs

How do I authenticate with the HubSpot API?

• Answer: HubSpot offers multiple authentication methods for its API:some text
  • Private Apps: Generate a personal access token within your HubSpot account. This method is recommended for most integrations.
  • OAuth: Use OAuth 2.0 for applications that require user authorization.
  • API Key: HubSpot is deprecating API keys in favor of private apps. It's advisable to transition to using private apps for authentication.
• Source: HubSpot API Authentication

What are the rate limits for the HubSpot API?

• Answer: HubSpot enforces rate limits to ensure fair usage:some text
  • Private Apps: The default limit is 100 requests per 10 seconds.
  • OAuth Apps: The default limit is 100 requests per 10 seconds per app per account.
  • API Key: The default limit is 100 requests per 10 seconds.
  • Some APIs may have stricter limits; always refer to the specific API documentation for details.
• Source: HubSpot API Usage Guidelines

How can I retrieve all contacts using the HubSpot API?

• Answer: To retrieve all contacts, use the CRM API's contacts endpoint:some text
  • Send a GET request to /crm/v3/objects/contacts.
  • Use pagination by including the after parameter to navigate through large sets of contacts.
  • You can also specify properties to include in the response using the properties parameter.
• Source: HubSpot CRM API | Contacts

Does HubSpot support webhooks for real-time data updates?

• Answer: Yes, HubSpot provides a Webhooks API that allows you to subscribe to specific events, such as contact creation or property changes. When these events occur, HubSpot sends HTTP POST requests to your configured endpoint.
• Source: HubSpot Webhooks API

Can I create custom objects in HubSpot via the API?

• Answer: Yes, HubSpot's CRM API allows you to define and manage custom objects. This enables you to tailor HubSpot's data structure to fit your business needs.
• Source: HubSpot CRM API | Custom Objects‍

‍

Get Started with Hubspot API Integration

For quick and seamless integration with HubSpot API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any HubSpot API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. 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 HubSpot API.‍

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

BambooHR is a leading cloud-based human resources software platform tailored for small to medium-sized businesses. It streamlines HR functions by offering a comprehensive suite of features such as employee data management, an applicant tracking system, onboarding tools, time-off management, performance management, and robust reporting and analytics. By centralizing these HR processes, BambooHR significantly reduces the administrative burden on HR teams, thereby enhancing overall productivity and efficiency.

One of the standout features of BambooHR is its employee self-service portal, which empowers employees to manage their own information, request time off, and access important documents, thereby fostering a more engaged and autonomous workforce. Additionally, the BambooHR API plays a crucial role in integrating this platform with other business systems, ensuring seamless data flow and enhancing the functionality of existing HR processes. In the following sections, we will delve deeper into the BambooHR API integration process and explore how it can be leveraged to optimize HR operations.

Key highlights of BambooHR APIs

• Easy Data Access
  • Allows interaction with core HR data for retrieval and updates.

• Automation
  • Supports automation through programmatic access to data and operations.

• Real-Time Sync
  • Supports webhooks for real-time notifications of actions.

• Strong Security
  • Provides detailed data access control.

• Scalable
  • Designed to handle requests efficiently with rate limiting.

• Developer-Friendly
  • RESTful API, familiar to developers.

• Error Handling and Logging
  • Requires handling of 503 Service Unavailable responses.

• Detailed Analytics and Reporting
  • Part of BambooHR's platform features.

• Sandbox Environment
  • Often provided for testing purposes.

BambooHR API Endpoints

Benefits

• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/benefits/settings/deduction_types/all : Get Benefit Deduction Types

Employee Dependents

• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employeedependents : Get All Employee Dependents
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employeedependents/{id} : Update An Employee Dependent

Employees

• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/ : Add Employee to BambooHR
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/changed : Gets All Updated Employee Ids
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/changed/tables/{table} : Gets All Updated Employee Table Data
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/files/categories : Add Employee File Category
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/photo : Store A New Employee Photo
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/photo/{size} : Get An Employee Photo
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/balance_adjustment/ : Adjust Time Off Balance
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/calculator : Estimate Future Time Off Balances
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/history/ : Add A Time Off History Item For Time Off Request
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/policies : Assign Time Off Policies For An Employee
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/request : Add A Time Off Request
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/ : Update Employee
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/files : Upload Employee File
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/files/view/ : List Employee Files and Categories
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/files/{fileId} : Update Employee File
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/tables/employmentStatus : Terminate Employee by Adding Row to Employment Status Table
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/tables/{table} : Adds A Table Row
• DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/tables/{table}/{rowId} : Deletes A Table Row

Company Files

• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/files : Upload Company File
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/files/categories : Add Company File Category
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/files/view/ : List Company Files And Categories
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/files/{fileId} : Update Company File

Login

• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/login : User Login

Meta

• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/meta/fields/ : Get A List Of Fields
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/meta/lists/ : Get Details For List Fields
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/meta/lists/{listFieldId} : Add Or Update Values For List Fields
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/meta/tables/ : Get A List Of Tabular Fields
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/meta/time_off/policies/ : Get Time Off Policies
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/meta/time_off/types/ : Get Time Off Types
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/meta/users/ : Get A List Of Users

Performance

• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals : Get Goals for an Employee
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/aggregate : Get All Aggregate Goal Info
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/alignmentOptions : Alignable Goal Options
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/canCreateGoals : Can Create A Goal
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/filters : Get Goal Status Counts
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/shareOptions : Available Goal Sharing Options
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId} : Update Goal
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/aggregate : Get Aggregate Goal Info
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/close : Close Goal
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/comments : Get Goal Comments
• DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/comments/{commentId} : Delete Goal Comment
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/progress : Update Goal Progress
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/reopen : Reopen A Goal
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/sharedWith : Update Goal Sharing

Reports

• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/reports/custom : List all employees
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/reports/{id} : Get Company Report

Time Off

• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_off/requests/ : Get Time Off Requests
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_off/requests/{requestId}/status : Change A Request Status
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_off/whos_out/ : Get A List Of Who's Out

Time Tracking

• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/clock_entries/delete : Delete Timesheet Clock Entries
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/clock_entries/store : Add or Edit Timesheet Clock Entries
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/employees/{employeeId}/clock_in : Add Timesheet Clock-in Entry
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/employees/{employeeId}/clock_out : Add Timesheet Clock-out Entry
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/employees/{employeeId}/projects : Get Employee Projects
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/hour_entries/delete : Delete Timesheet Hour Entries
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/hour_entries/store : Add or Edit Timesheet Hour Entries
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/projects : Create A Time Tracking Project
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/timesheet_entries : Get Timesheet Entries
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/add : Add An Hour Record
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/adjust : Edit An Hour Record
• DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/delete/{id} : Delete An Hour Record
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/record : Bulk Add or Edit Hour Records
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/record/{id} : Get an Hour Record

Training

• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/category : List Training Categories
• DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/category/{trainingCategoryId} : Delete Training Category
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/record/employee/{employeeId} : List Employee Trainings
• DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/record/{employeeTrainingRecordId} : Delete Employee Training Record
• POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/type : Add Training Type
• PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/type/{trainingTypeId} : Update Training Type

Webhooks

• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/webhooks/ : Gets List Of Webhooks For The User API Key
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/webhooks/monitor_fields : Get Monitor Fields
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/webhooks/{id}/ : Get Webhook
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/webhooks/{id}/log : Get Webhook Logs

Version 1.1

• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1_1/employees/{employeeId}/time_off/policies : Assign Time Off Policies For An Employee
• GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1_1/performance/employees/{employeeId}/goals/filters : Get Goal Status Counts Version 1.1

‍

BambooHR API FAQs

1. How do I generate an API key in BambooHR?
   • Answer: To generate an API key in BambooHR, log in to your account and click your name in the upper right-hand corner to access the user context menu. If you have sufficient permissions, select "API Keys" from the menu. On the API Keys page, click "Add New Key," provide a name for the key, and then click "Generate Key." Once generated, copy the key and store it securely, as it will not be displayed again.
   • Source: Getting Started With The API - BambooHR
2. What authentication method does the BambooHR API use?
   • Answer: The BambooHR API uses HTTP Basic Authentication. When making API requests, use the API key as the username and any random string as the password. Include these credentials in the 'Authorization' header of your HTTP requests.
   • Source: Getting Started With The API - BambooHR
3. Are there rate limits for the BambooHR API?
   • Answer: Yes, the BambooHR API enforces rate limits to ensure fair usage and system stability. If requests are deemed too frequent, the API may throttle them, resulting in a 503 Service Unavailable response. It's recommended to implement error handling in your application to manage such responses appropriately.
   • Source: Technical Overview - BambooHR
4. Can I retrieve employee data using the BambooHR API?
   • Answer: Yes, you can retrieve employee data using the BambooHR API. To get data for a specific employee, make a GET request to the endpoint /v1/employees/{id}/, where {id} is the employee's ID. You can specify which fields to retrieve by including a comma-separated list of field names in the fields query parameter.
   • Source: Get Employee - BambooHR
5. Does the BambooHR API support webhooks?
   • Answer: As of the latest available information, BambooHR supports two types of webhooks - global and permissioned. Global webhooks work on a subset of fields with open access while permissioned webhooks enable all fields but access is restricted via access control. You can also use third party service providers like Knit which provide virtual webhooks even for fields not supported natively by the BambooHR API for webhook functinality.‍
   • Source: Webhooks - BambooHR

Get Started with BambooHR API Integration

For quick and seamless integration with BambooHR API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any BambooHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, HRIS, Payroll and other systems in one go with a unified approach. 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 BambooHR 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.

Key highlights of 7Shifts APIs

• Easy Data Access:
  • Organized around predictable, resource-oriented URLs for easier data management.
• Automation:
  • Supports automation through integration with other systems.
• Custom Integration:
  • Integrates with key POS, time clocking, and payroll software for enhanced management processes.
• Real-Time Sync:
  • Supports webhooks for real-time data synchronization and event-driven actions.
• Strong Security:
  • Uses HTTP response codes for secure communication.
• Scalable:
  • Handles multiple requests with rate limiting at 10 requests per second per access token.
• Developer-Friendly:
  • Follows RESTful principles with predictable URLs.
• Error Handling and Logging:
  • Utilizes HTTP response codes for effective error handling.
• Rate Limiting:
  • Enforces rate limits to ensure fair usage.
• Webhook Support:
  • Enables real-time data synchronization and event-driven actions.

7Shifts API Endpoints

Authentication

• POST https://api.7shifts.com/oauth2/token : Acquire OAuth Token

Company

• GET https://api.7shifts.com/v2/companies/{id} : Get Company Details
• POST https://api.7shifts.com/v2/company/{company_id}/create_many_users : Create Multiple Users in a Company
• GET https://api.7shifts.com/v2/company/{company_id}/departments : Get Company Departments
• PUT https://api.7shifts.com/v2/company/{company_id}/departments/{department_id} : Update Department Details
• GET https://api.7shifts.com/v2/company/{company_id}/events : Get Company Events
• DELETE https://api.7shifts.com/v2/company/{company_id}/events/{event_id} : Delete Event from Company
• GET https://api.7shifts.com/v2/company/{company_id}/external_user_mappings : Get External User Mappings for a Company
• PUT https://api.7shifts.com/v2/company/{company_id}/external_user_mappings/{identifier} : Update External User Mappings
• POST https://api.7shifts.com/v2/company/{company_id}/external_user_mappings_bulk : Bulk External User Mappings for a Company
• GET https://api.7shifts.com/v2/company/{company_id}/inactive_reasons : Get Inactive Reasons for a Company
• GET https://api.7shifts.com/v2/company/{company_id}/labor_settings : Get Company Labor Settings
• GET https://api.7shifts.com/v2/company/{company_id}/roles : Get Company Roles
• GET https://api.7shifts.com/v2/company/{company_id}/roles/{role_id} : Get Role Details for a Company
• GET https://api.7shifts.com/v2/company/{company_id}/shift_feedback : Get Shift Feedback for a Company
• GET https://api.7shifts.com/v2/company/{company_id}/task_management_settings : Get Task Management Settings for a Company
• POST https://api.7shifts.com/v2/company/{company_id}/task_tags : Create Task Tags for a Company
• GET https://api.7shifts.com/v2/company/{company_id}/test_webhook : Test Webhook for a Company
• GET https://api.7shifts.com/v2/company/{company_id}/webhooks : Get Company Webhooks
• DELETE https://api.7shifts.com/v2/company/{company_id}/webhooks/{webhook_id} : Delete Webhook for a Company
• POST https://api.7shifts.com/v2/partner_company_creation : Create Trial Company

Locations

• GET https://api.7shifts.com/api/v2/company/{company_id}/location/{location_id}/daily_stats : Get Daily Statistics for a Company Location
• POST https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/forecast_override : Create Forecast Override for a Location
• GET https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/sales_category_mappings : Get Sales Category Mappings for a Location
• DELETE https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/sales_category_mappings/{external_id} : Delete Sales Category Mapping
• POST https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/sales_category_mappings_bulk : Bulk Sales Category Mappings for a Location
• GET https://api.7shifts.com/v2/company/{company_id}/locations : Get Company Locations
• DELETE https://api.7shifts.com/v2/company/{company_id}/locations/{location_id} : Delete Location from Company
• GET https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/engage_overview : Get Engage Overview for a Location
• POST https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/forecast_override_interval : Override Project Sales Interval
• POST https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/forecast_overrides_intervals : Override Project Sales Intervals
• GET https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/tip_pool_detailed_report : Get Tip Pool Detailed Report
• GET https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/tip_pool_summary_report : Get Tip Pool Summary Report

Availabilities

• POST https://api.7shifts.com/v2/company/{company_id}/availabilities : Create Company Availability
• PUT https://api.7shifts.com/v2/company/{company_id}/availabilities/{availability_id} : Update Availability for a Company
• PUT https://api.7shifts.com/v2/company/{company_id}/availabilities/{availability_id}/status : Update Availability Status
• GET https://api.7shifts.com/v2/company/{company_id}/availability_reasons : Get Availability Reasons for a Company
• PUT https://api.7shifts.com/v2/company/{company_id}/availability_reasons/{availability_reason_id} : Update Availability Reason for a Company

Log Book

• GET https://api.7shifts.com/v2/company/{company_id}/log_book_categories : Get Log Book Categories for a Company
• PATCH https://api.7shifts.com/v2/company/{company_id}/log_book_categories/{id} : Update Log Book Category
• POST https://api.7shifts.com/v2/company/{company_id}/log_book_comments : Create Log Book Comment
• GET https://api.7shifts.com/v2/company/{company_id}/log_book_comments/{id} : Get Log Book Comment Details
• GET https://api.7shifts.com/v2/company/{company_id}/log_book_posts : Get Log Book Posts for a Company
• DELETE https://api.7shifts.com/v2/company/{company_id}/log_book_posts/{id} : Delete Log Book Post

Receipts

• POST https://api.7shifts.com/v2/company/{company_id}/receipts : Create Company Receipt
• PUT https://api.7shifts.com/v2/company/{company_id}/receipts/{receipt_id} : Update Receipt Details
• GET https://api.7shifts.com/v2/company/{company_id}/receipts_summary : Get Receipts Summary for a Company

Shifts

• POST https://api.7shifts.com/v2/company/{company_id}/shifts : Create a Shift for a Company
• GET https://api.7shifts.com/v2/company/{company_id}/shifts/{shift_id} : Get Shift Details
• GET https://api.7shifts.com/v2/company/{company_id}/shifts_scheduled/{id} : Get Scheduled Shift Details

Task Lists

• GET https://api.7shifts.com/v2/company/{company_id}/task_list_daily_summary : Get Task List Daily Summary
• POST https://api.7shifts.com/v2/company/{company_id}/task_list_templates : Create Task List Template
• PUT https://api.7shifts.com/v2/company/{company_id}/task_list_templates/{uuid} : Update Task List Template
• GET https://api.7shifts.com/v2/company/{company_id}/task_lists : Get Task Lists for a Company
• GET https://api.7shifts.com/v2/company/{company_id}/task_lists/{list_id} : Get Task List Details
• POST https://api.7shifts.com/v2/company/{company_id}/task_lists/{list_id}/tasks/{task_id}/clear : Clear a Task in a Task List for a Company
• POST https://api.7shifts.com/v2/company/{company_id}/task_lists/{list_id}/tasks/{task_id}/complete : Complete a Task in a Task List for a Company

Time Punches

• POST https://api.7shifts.com/v2/company/{company_id}/time_punches : Create Time Punch for a Company
• GET https://api.7shifts.com/v2/company/{company_id}/time_punches/{time_punch_id} : Get Time Punch Details

Tip Pool

• PUT https://api.7shifts.com/v2/company/{company_id}/tip_pool/{tip_pool_settings_uuid}/manual_entry : Update Manual Entry for Tip Pool
• GET https://api.7shifts.com/v2/company/{company_id}/tip_pool_settings : Get Tip Pool Settings for a Company

Users

• POST https://api.7shifts.com/v2/company/{company_id}/users : Create a New User in a Company
• DELETE https://api.7shifts.com/v2/company/{company_id}/users/{identifier} : Delete User from Company
• GET https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/assignments : Get User Assignments in a Company
• POST https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/department_assignments : Create Department Assignment for User
• DELETE https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/department_assignments/{department_id} : Delete User Department Assignment
• GET https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/location_assignments : Get User Location Assignments
• DELETE https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/location_assignments/{location_id} : Delete User Location Assignment
• POST https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/role_assignments : Assign Role to User in Company
• DELETE https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/role_assignments/{role_id} : Delete Role Assignment for a User in a Company
• POST https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/wages : Create User Wage

Reports

• GET https://api.7shifts.com/v2/reports/daily_sales_and_labor : Get Daily Sales and Labor Report
• GET https://api.7shifts.com/v2/reports/hours_and_wages : Get Hours and Wages Report

Time Off

• GET https://api.7shifts.com/v2/time_off : Get Time Off Details
• GET https://api.7shifts.com/v2/time_off/total_hours : Get Total Time Off Hours
• PATCH https://api.7shifts.com/v2/time_off/{time_off_id} : Update Time Off Request
• POST https://api.7shifts.com/v2/time_off/{time_off_id}/approve : Approve Time Off Request
• POST https://api.7shifts.com/v2/time_off/{time_off_id}/decline : Decline Time Off Request
• POST https://api.7shifts.com/v2/time_off_settings/{company_id} : Set Time Off Settings for a Company

User Identity

• GET https://api.7shifts.com/v2/whoami : Get User Identity and Details

‍

7Shifts API FAQs

‍

1. How do I authenticate my API requests to 7Shifts?

• 7Shifts uses OAuth 2.0 for authentication. You'll need to obtain a client ID and client secret from 7Shifts to generate access tokens.
• Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/authentication

2. What are the rate limits for the 7Shifts API?

• 7Shifts has rate limits in place to prevent abuse. Refer to the official documentation for the specific rate limits and potential throttling mechanisms.
• Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/introduction

3. How can I create a new employee in 7Shifts using the API?

• You can use the POST /users endpoint to create new employees. Refer to the API documentation for the required parameters and request body format.
• Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/users

4. Can I use webhooks with the 7Shifts API to receive real-time notifications?

• Yes, 7Shifts supports webhooks for real-time notifications. You can configure webhooks to receive updates on various events, such as new shifts, time-off requests, and more.
• Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/webhooks

5. What are the best practices for error handling in 7Shifts API integrations?

• Always check the HTTP status code of API responses to identify errors. 7Shifts API returns detailed error messages in the response body. Handle different error codes appropriately to ensure your integration is robust.
• Source: 7Shifts API Documentation: https://developers.7shifts.com/

‍

Get Started with 7Shifts API Integration

For quick and seamless integration with 7Shifts API, Knit API offers a convenient solution. It’s AI powered unified integration platform allows you to build any 7Shifts API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, HRIS, Payroll and other systems in one go with a unified approach. 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 7Shifts API.

‍

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

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.

Key highlights of Deel APIs

• 1. Easy Data Access:
  • Seamless data access for integration with internal tools.
• 2. Automation:
  • Supports HR workflow automation to reduce manual tasks.
• 3. Custom Integration:
  • Flexible integration into existing tech stacks.
• 4. Real-Time Sync:
  • Ensures up-to-date information with real-time data synchronization.
• 5. Scalable:
  • Designed to scale with business needs.
• 6. Developer-Friendly:
  • Accessible for developers with efficient integration support.
• 7. Global Support:
  • Ensures functionality across different regions.
• 8. Error Handling and Logging:
  • Common in APIs for managing and troubleshooting issues.
• 9. Rate Limiting:
  • Typically included to manage API usage.
• 10. Version Control:
  • Often part of API management for updates and changes.
• 11. Data Transformation:
  • Ensures compatibility, though specifics weren't provided.
• 12. Webhook Support:
  • Commonly used for event-driven updates.
• 13. Detailed Analytics and Reporting:
  • Often provided for monitoring usage and performance.
• 14. Sandbox Environment:
  • Offers 60-day access to developer sandboxes for testing.

Deel API Endpoints

Adjustments

• POST https://api.letsdeel.com/rest/v2/adjustments : Create a New Adjustment
• GET https://api.letsdeel.com/rest/v2/adjustments/categories : Get Adjustment Categories for Organization
• DELETE https://api.letsdeel.com/rest/v2/adjustments/{adjustment_id} : Delete Adjustment

Candidates

• POST https://api.letsdeel.com/rest/v2/candidates : Add a Candidate to Deel
• PATCH https://api.letsdeel.com/rest/v2/candidates/{candidate_id} : Update Candidate

Contracts

• GET https://api.letsdeel.com/rest/v2/contract-templates : Retrieve Contract Templates
• GET https://api.letsdeel.com/rest/v2/contracts : Retrieve a list of contracts
• GET https://api.letsdeel.com/rest/v2/contracts/custom_fields : Fetch Custom Fields for Contracts
• GET https://api.letsdeel.com/rest/v2/contracts/custom_fields/{field_id} : Get Contract Custom Field Details
• POST https://api.letsdeel.com/rest/v2/contracts/gp : Create Global Payroll Contract
• PATCH https://api.letsdeel.com/rest/v2/contracts/{contract_id} : Add External ID to Deel Contract
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/adjustments : Get Adjustments for Specific Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/amendments : Amend Contract Details
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/custom_fields : Get Custom Field Values for a Contract
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/custom_fields/{field_id} : Delete Custom Field Value from Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/documents : Attach a File to Contract Document
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/invitations : Remove Contract Invitation
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/invoice-adjustments : Retrieve Invoice Line Items for a Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones : Add a New Milestone to Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/many/reviews : Review Batch of Milestones
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/{milestone_id} : Delete Milestone from Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/{milestone_id}/reviews : Review Milestone to Approve or Decline Submitted Work
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/off-cycle-payments : Retrieve Off-Cycle Payments for a Contract
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/off-cycle-payments/{offcycle_payment_id} : Retrieve a Single Off-Cycle Payment
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/premium : Remove Deel Premium from Contract
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/preview : Retrieve IC and EOR Contract Agreement Content
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/signatures : Sign Contract as Client
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks : Retrieve Tasks for a Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/many/reviews : Review Multiple Tasks for Approval or Decline
• DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/{task_id} : Delete Task from Contract
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/{task_id}/reviews : Review Task for Approval or Decline
• POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/terminations : Terminate an Active Contract
• GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/timesheets : Retrieve Timesheets for a Contract

Departments

• GET https://api.letsdeel.com/rest/v2/departments : Get List of Organization Departments

Employee of Record (EOR)

• POST https://api.letsdeel.com/rest/v2/eor : Create Employee of Record Contract Quote
• POST https://api.letsdeel.com/rest/v2/eor/employment_cost : Determine EOR Employee Costs
• GET https://api.letsdeel.com/rest/v2/eor/validations/{country_code} : Retrieve Hiring Guide Data for a Country
• GET https://api.letsdeel.com/rest/v2/eor/workers/{worker_id}/payslips/{payslip_id}/download : Get Download URL for EOR Payslip
• GET https://api.letsdeel.com/rest/v2/eor/{contract_id}/benefits : Retrieve EOR Contract Benefits

Global Payroll (GP)

• GET https://api.letsdeel.com/rest/v2/gp/legal-entities/{legal_entity_id}/reports : Get Global Payroll Events by Legal Entity
• GET https://api.letsdeel.com/rest/v2/gp/reports/{gp_report_id}/gross_to_net : Get Global Payroll Gross-to-Net Reports
• GET https://api.letsdeel.com/rest/v2/gp/reports/{gp_report_id}/gross_to_net/csv : Download Global Payroll Gross-to-Net Report
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/address : Update Global Payroll Employee Address
• GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks : Retrieve Employee Bank Accounts
• GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks/guide : Retrieve Bank Form Guide for Employee
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks/{bank_id} : Modify Bank Account for an Employee
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/compensation : Update Global Payroll Employee Compensation
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/employee-information : Update Global Payroll Employee Information
• GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/payslips : Get Payslips for an Employee
• GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/payslips/{payslip_id}/download : Get Download URL for GP Payslip
• PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/pto-policy : Update PTO Policy of Global Payroll Employee
• POST https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/terminations : Request Termination for Global Payroll Employee

Invoice Adjustments

• POST https://api.letsdeel.com/rest/v2/invoice-adjustments : Create Invoice Adjustment
• POST https://api.letsdeel.com/rest/v2/invoice-adjustments/many/reviews : Review Multiple Invoice Adjustments
• DELETE https://api.letsdeel.com/rest/v2/invoice-adjustments/{invoice_adjustment_id} : Delete Invoice Adjustment
• POST https://api.letsdeel.com/rest/v2/invoice-adjustments/{invoice_adjustment_id}/reviews : Review Invoice Adjustment

Invoices

• GET https://api.letsdeel.com/rest/v2/invoices : Retrieve Paid Invoices
• GET https://api.letsdeel.com/rest/v2/invoices/deel : Retrieve Deel Invoices

Legal Entities

• GET https://api.letsdeel.com/rest/v2/legal-entities : Retrieve Legal Entities

Lookups

• GET https://api.letsdeel.com/rest/v2/lookups/countries : Retrieve Supported Countries by Deel
• GET https://api.letsdeel.com/rest/v2/lookups/currencies : Retrieve List of Currencies
• GET https://api.letsdeel.com/rest/v2/lookups/job-titles : Retrieve Pre-defined Job Titles
• GET https://api.letsdeel.com/rest/v2/lookups/seniorities : Retrieve Seniority Levels
• GET https://api.letsdeel.com/rest/v2/lookups/time-off-types : Retrieve Pre-defined Time Off Types

Managers

• GET https://api.letsdeel.com/rest/v2/managers : List Organization Managers

Organizations

• GET https://api.letsdeel.com/rest/v2/organizations : Retrieve Current Organization Details

Payments

• GET https://api.letsdeel.com/rest/v2/payments : Retrieve Payments List
• GET https://api.letsdeel.com/rest/v2/payments/{payment_id}/breakdown : Get Payment Breakdown

People

• POST https://api.letsdeel.com/rest/v2/people : Create Employee in Deel HR
• GET https://api.letsdeel.com/rest/v2/people/custom_fields : Fetch Custom Fields for People Records
• GET https://api.letsdeel.com/rest/v2/people/custom_fields/{field_id} : Get Custom Field Details
• GET https://api.letsdeel.com/rest/v2/people/{worker_id} : Retrieve a Single Person in Your Organization
• PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/custom_fields : Add or Update Custom Field Values for a Worker
• DELETE https://api.letsdeel.com/rest/v2/people/{worker_id}/custom_fields/{field_id} : Delete Custom Field from Worker's Profile
• PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/department : Update Worker Department
• PATCH https://api.letsdeel.com/rest/v2/people/{worker_id}/personal : Update Worker's Personal Information
• PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/working-location : Update Worker Working Location

Teams

• GET https://api.letsdeel.com/rest/v2/teams : Retrieve Organization Teams

Timesheets

• POST https://api.letsdeel.com/rest/v2/timesheets : Submit Work for a Contractor
• POST https://api.letsdeel.com/rest/v2/timesheets/many/reviews : Review Batch of Timesheets
• DELETE https://api.letsdeel.com/rest/v2/timesheets/{timesheet_id} : Delete a Single Timesheet Entry
• POST https://api.letsdeel.com/rest/v2/timesheets/{timesheet_id}/reviews : Review Timesheet

Webhooks

• POST https://api.letsdeel.com/rest/v2/webhooks : Create a new webhooks subscription
• GET https://api.letsdeel.com/rest/v2/webhooks/events/types : Retrieve Webhook Event Types
• DELETE https://api.letsdeel.com/rest/v2/webhooks/{id} : Delete Webhook Subscription

Workers

• GET https://api.letsdeel.com/rest/v2/workers/{worker_id}/documents : Retrieve Worker Documents
• GET https://api.letsdeel.com/rest/v2/workers/{worker_id}/documents/{document_id}/download : Get Worker Document Download Link

Working Locations

• GET https://api.letsdeel.com/rest/v2/working-locations : Get Organization Working Locations

SCIM

• GET https://api.letsdeel.com/scim/v2/Users : List users
• PATCH https://api.letsdeel.com/scim/v2/Users/{id} : Partially update/patch a user

‍

Deel API FAQs‍

1. How do I create a new contractor in Deel using the API?some text
   • You can use the POST /contracts endpoint to create new contractor contracts. Refer to the API documentation for the required parameters and request body format.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome
2. Can I use the Deel API to automate payroll processing?some text
   • Yes, the Deel API allows you to automate payroll processing by creating pay runs, generating payslips, and making payments.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome
3. How does authentication work with the Deel API?some text
   • Deel uses API tokens for authentication. You can generate API tokens in the Deel Developer Center.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome
4. What are the rate limits for the Deel API?some text
   • Deel has rate limits in place to prevent abuse. Refer to the official documentation for the specific rate limits and potential throttling mechanisms.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome
5. How can I handle errors and exceptions in Deel API integrations?some text
   • Deel API returns detailed error messages in the response body. Handle different error codes appropriately to ensure your integration is robust.
   • Source: Deel API Documentation: https://developer.deel.com/docs/welcome

Get Started with Deel API Integration

For quick and seamless integration with Deel API, Knit APIoffers a convenient solution. It’s AI powered integration platform allowsyou to build any DeelAPI Integration use case. By integrating with Knit just once, you canintegrate with multiple other ATS, HRIS, Payroll and other systems in one gowith a unified approach. Knit takes care of all the authentication,authorization, and ongoing integration maintenance. This approach not onlysaves time but also ensures a smooth and reliable connection to 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.

Key highlights of Ashby APIs

• Automation
  • The API facilitates the automation of various HR tasks, including payroll and benefits management, allowing businesses to focus on core activities.
• Data Integration
  • It enables seamless integration of data, logic, and objects with other software applications, enhancing data flow and operational efficiency.
• Recruitment Platform Integration
  • The API supports integration with Ashby's recruitment platform, consolidating ATS, analytics, scheduling, and CRM functionalities.
• Cloud Data Warehouse Integration
  • Replicating Ashby data into a cloud data warehouse can unlock opportunities for advanced analytics, workflow automation, and product development.
• Communication and HR Systems
  • Ashby API integrates with communication tools, sourcing platforms, HRIS, assessment tools, and job boards, streamlining recruitment workflows.
• AI Interaction
  • The integration allows AI agents to interact with and automate processes within Ashby, improving candidate evaluation and talent management.
• Unified API
  • Through Knit's ATS Unified API, Ashby can connect with various applications, helping businesses close more deals, retain customers, and expand into new markets.
• Ease of Use
  • The integration capabilities make processes like pushing new hire data from other platforms to Ashby simple and efficient.

Ashby API Endpoints

API Key

• POST https://api.ashbyhq.com/apiKey.info : Retrieve API Key Information

Application

• POST https://api.ashbyhq.com/application.addHiringTeamMember : Add Hiring Team Member to Application
• POST https://api.ashbyhq.com/application.change_source : Change Application Source
• POST https://api.ashbyhq.com/application.change_stage : Change Application Stage
• POST https://api.ashbyhq.com/application.create : Create Application
• POST https://api.ashbyhq.com/application.info : Fetch Application Details
• POST https://api.ashbyhq.com/application.list : List Applications
• POST https://api.ashbyhq.com/application.update : Update Application
• POST https://api.ashbyhq.com/applicationFeedback.list : List Application Feedback
• POST https://api.ashbyhq.com/applicationFeedback.submit : Submit Application Feedback
• POST https://api.ashbyhq.com/applicationForm.submit : Submit Application Form
• POST https://api.ashbyhq.com/applicationHiringTeamRole.list : List Application Hiring Team Roles

Approval

• POST https://api.ashbyhq.com/approvalDefinition.update : Update Approval Definition

Archive

• POST https://api.ashbyhq.com/archiveReason.list : List Archive Reasons

Assessment

• POST https://api.ashbyhq.com/assessment.addCompletedToCandidate : Add Completed Assessment to Candidate
• POST https://api.ashbyhq.com/assessment.cancel : Cancel Assessment
• POST https://api.ashbyhq.com/assessment.start : Start Assessment
• POST https://api.ashbyhq.com/assessment.update : Update Assessment Status

Candidate

• POST https://api.ashbyhq.com/candidate.addTag : Add Tag to Candidate
• POST https://api.ashbyhq.com/candidate.create : Create Candidate
• POST https://api.ashbyhq.com/candidate.createNote : Create Note on Candidate
• POST https://api.ashbyhq.com/candidate.info : Candidate Information Retrieval
• POST https://api.ashbyhq.com/candidate.list : List Candidates
• POST https://api.ashbyhq.com/candidate.listNotes : List Candidate Notes
• POST https://api.ashbyhq.com/candidate.search : Candidate Search API
• POST https://api.ashbyhq.com/candidate.update : Update Candidate
• POST https://api.ashbyhq.com/candidate.uploadFile : Upload Candidate File
• POST https://api.ashbyhq.com/candidate.uploadResume : Candidate Resume Upload
• POST https://api.ashbyhq.com/candidateTag.create : Create Candidate Tag
• POST https://api.ashbyhq.com/candidateTag.list : List Candidate Tags
• POST https://api.ashbyhq.com/canidate.anonymize : Anonymize Candidate

Custom Field

• POST https://api.ashbyhq.com/customField.create : Create Custom Field
• POST https://api.ashbyhq.com/customField.list : List Custom Fields
• POST https://api.ashbyhq.com/customField.setValue : Set Custom Field Value

Department

• POST https://api.ashbyhq.com/department.create : Create Department
• POST https://api.ashbyhq.com/department.info : Fetch Department Details
• POST https://api.ashbyhq.com/department.list : List Departments

Feedback Form

• POST https://api.ashbyhq.com/feedbackFormDefinition.info : Feedback Form Definition Information
• POST https://api.ashbyhq.com/feedbackFormDefinition.list : List Feedback Form Definitions

File

• POST https://api.ashbyhq.com/file.info : Retrieve File URL for Candidate

Hiring Team

• POST https://api.ashbyhq.com/hiringTeam.addMember : Add Member to Hiring Team
• POST https://api.ashbyhq.com/hiringTeamRole.list : List Hiring Team Roles

Interview

• POST https://api.ashbyhq.com/interview.info : Fetch Interview Details by ID
• POST https://api.ashbyhq.com/interview.list : List Interviews
• POST https://api.ashbyhq.com/interviewEvent.list : List Interview Events
• POST https://api.ashbyhq.com/interviewPlan.list : List Interview Plans
• POST https://api.ashbyhq.com/interviewSchedule.cancel : Cancel Interview Schedule
• POST https://api.ashbyhq.com/interviewSchedule.create : Create Scheduled Interview
• POST https://api.ashbyhq.com/interviewSchedule.list : List Interview Schedules
• POST https://api.ashbyhq.com/interviewSchedule.update : Update Interview Schedule
• POST https://api.ashbyhq.com/interviewStage.info : Fetch Interview Stage Details
• POST https://api.ashbyhq.com/interviewStage.list : List Interview Stages

Interviewer Pool

• POST https://api.ashbyhq.com/interviewerPool.addUser : Add User to Interviewer Pool
• POST https://api.ashbyhq.com/interviewerPool.archive : Archive Interviewer Pool
• POST https://api.ashbyhq.com/interviewerPool.create : Create Interviewer Pool
• POST https://api.ashbyhq.com/interviewerPool.info : Interviewer Pool Information
• POST https://api.ashbyhq.com/interviewerPool.list : List Interviewer Pools
• POST https://api.ashbyhq.com/interviewerPool.removeUser : Remove User from Interviewer Pool
• POST https://api.ashbyhq.com/interviewerPool.restore : Restore Interviewer Pool
• POST https://api.ashbyhq.com/interviewerPool.update : Update Interviewer Pool

Job

• POST https://api.ashbyhq.com/job.create : Create a New Job
• POST https://api.ashbyhq.com/job.info : Job Information Retrieval
• POST https://api.ashbyhq.com/job.list : List Jobs
• POST https://api.ashbyhq.com/job.search : Job Search API
• POST https://api.ashbyhq.com/job.setStatus : Set Job Status
• POST https://api.ashbyhq.com/job.update : Update Job Details

Job Posting

• POST https://api.ashbyhq.com/jobPosting.info : Retrieve Job Posting Information
• POST https://api.ashbyhq.com/jobPosting.list : List Job Postings
• POST https://api.ashbyhq.com/jobPosting.update : Update Job Posting

Location

• POST https://api.ashbyhq.com/location.create : Create Location or Location Hierarchy
• POST https://api.ashbyhq.com/location.info : Location Information Retrieval
• POST https://api.ashbyhq.com/location.list : List All Locations

Offer

• POST https://api.ashbyhq.com/offer.create : Create Offer
• POST https://api.ashbyhq.com/offer.info : Offer Information Retrieval
• POST https://api.ashbyhq.com/offer.list : List Offers with Latest Version
• POST https://api.ashbyhq.com/offer.start : Start Offer Process

Opening

• POST https://api.ashbyhq.com/opening.addJob : Add Job to Opening
• POST https://api.ashbyhq.com/opening.create : Create Opening
• POST https://api.ashbyhq.com/opening.info : Retrieve Opening Information
• POST https://api.ashbyhq.com/opening.list : List Openings
• POST https://api.ashbyhq.com/opening.removeJob : Remove Job from Opening
• POST https://api.ashbyhq.com/opening.search : Opening Search
• POST https://api.ashbyhq.com/opening.setArchived : Set Archived State of an Opening
• POST https://api.ashbyhq.com/opening.setOpeningState : Set Opening State
• POST https://api.ashbyhq.com/opening.update : Update Opening

Referral

• POST https://api.ashbyhq.com/referral.create : Create Referral
• POST https://api.ashbyhq.com/referralForm.info : Referral Form Information

Source

• POST https://api.ashbyhq.com/source.list : List All Sources

Survey

• POST https://api.ashbyhq.com/surveyFormDefinition.info : Survey Form Definition Information
• POST https://api.ashbyhq.com/surveyFormDefinition.list : List Survey Form Definitions
• POST https://api.ashbyhq.com/surveyRequest.create : Create Survey Request
• POST https://api.ashbyhq.com/surveySubmission.list : List Survey Submissions

User

• POST https://api.ashbyhq.com/user.info : Get Ashby User Information
• POST https://api.ashbyhq.com/user.list : List Users
• POST https://api.ashbyhq.com/user.search : User Search by Email

Webhook

• POST https://api.ashbyhq.com/webhook.create : Create Webhook Setting
• POST https://api.ashbyhq.com/webhook.delete : Delete Webhook Setting
• POST https://api.ashbyhq.com/webhook.update : Update Webhook Setting

‍

‍

Ashby API FAQs

1. How do I authenticate my API requests to Ashby ATS?
   • Ashby ATS uses API keys for authentication. You can generate API keys in the Ashby ATS settings.
   • Source: Ashby ATS API Documentation: https://developers.ashbyhq.com/
2. Can I use the Ashby ATS API to create new job postings?
   • Yes, you can use the POST /jobs endpoint to create new job postings. Refer to the API documentation for the required parameters and request body format.
   • Source: Ashby ATS API Documentation: https://developers.ashbyhq.com/
3. How can I retrieve a list of candidates using the Ashby ATS API?
   • You can use the GET /candidates endpoint to retrieve a list of candidates. You can filter the results using various parameters, such as job ID, status, and more.
   • Source: Ashby ATS API Documentation: https://developers.ashbyhq.com/
4. What are the rate limits for the Ashby ATS API?
   • Ashby ATS has rate limits in place to prevent abuse. Refer to the official documentation for the specific rate limits and potential throttling mechanisms.
   • Source: Ashby ATS API Documentation: https://developers.ashbyhq.com/
5. How can I handle errors and exceptions in Ashby ATS API integrations?
   • Ashby ATS API returns detailed error messages in the response body. Handle different error codes appropriately to ensure your integration is robust.
   • Source: Ashby ATS API Documentation: https://developers.ashbyhq.com/

Get Started with Ashby API Integration

For quick and seamless integration with Ashby API, Knit API offers a convenient solution. It's AI powered integration platform allows you to build any Ashby API Integration use case. 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 Ashby API.

‍

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:

1. Employee Data Management:
   • Employee Information: Access and update employee details such as personal information, job history, and compensation.
   • Employee Self-Service: Enable employees to view and update their information, including personal details, pay stubs, and benefits.
2. Payroll Processing:
   • Payroll Calculations: Integrate payroll calculations, including earnings, deductions, and taxes.
   • Payroll Reports: Retrieve payroll reports for auditing and compliance purposes.
3. Time and Attendance:
   • Time Tracking: Access and manage employee time and attendance data, including clock-in/clock-out records and time-off requests.
   • Scheduling: Integrate with scheduling systems to manage employee shifts and work schedules.
4. Benefits Administration:
   • Benefits Enrollment: Manage employee benefits enrollment, including health insurance, retirement plans, and other benefits.
   • Benefits Reporting: Retrieve data on employee benefits usage and enrollment for reporting and compliance.
5. Compliance and Reporting:
   • Tax Compliance: Access and manage tax information, including filings and withholdings.
   • Regulatory Reports: Retrieve and generate reports required for regulatory compliance.
6. Recruitment and Onboarding:
   • Applicant Tracking: Integrate with applicant tracking systems to manage job postings, applications, and candidate information.
   • Onboarding: Facilitate the onboarding process for new hires, including document management and training.
7. Security and Access Control:
   • User Authentication: Manage user authentication and authorization to ensure secure access to API functionalities.
   • Data Encryption: Ensure that data transmitted via APIs is encrypted for security and privacy.

‍

Paycom API Endpoints

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:

1. Employee Management
   • GET /employees: Retrieve a list of employees or specific employee details.
   • POST /employees: Create a new employee record.
   • PUT /employees/{employee_id}: Update an existing employee record.
   • DELETE /employees/{employee_id}: Delete an employee record.
2. Payroll Processing
   • GET /payrolls: Retrieve payroll information and details.
   • POST /payrolls: Submit payroll data for processing.
   • GET /payrolls/{payroll_id}: Get details of a specific payroll run.
   • GET /payrolls/{payroll_id}/reports: Retrieve payroll reports associated with a specific payroll run.
3. Time and Attendance
   • GET /time_entries: Retrieve time and attendance records.
   • POST /time_entries: Submit new time and attendance entries.
   • PUT /time_entries/{entry_id}: Update existing time and attendance records.
   • DELETE /time_entries/{entry_id}: Delete a time and attendance record.
4. Benefits Administration
   • GET /benefits: Retrieve benefits information and details.
   • POST /benefits: Enroll employees in benefits programs.
   • GET /benefits/{benefit_id}: Get details of a specific benefit plan.
   • PUT /benefits/{benefit_id}: Update benefit plan details.
5. Compliance and Reporting
   • GET /taxes: Retrieve tax information and details.
   • POST /taxes: Submit tax-related data.
   • GET /reports: Retrieve various compliance and regulatory reports.
   • GET /reports/{report_id}: Get details of a specific report.
6. Recruitment and Onboarding
   • GET /applicants: Retrieve a list of job applicants and their details.
   • POST /applicants: Submit new applicant information.
   • GET /applicants/{applicant_id}: Get details of a specific applicant.
   • PUT /applicants/{applicant_id}: Update applicant details.
7. Security and Access Control
   • POST /auth/token: Obtain an authentication token for API access.
   • GET /users: Retrieve user information and permissions.
   • PUT /users/{user_id}: Update user permissions and access.

‍

Paycom API FAQs

‍

Here are the frequently asked questions about Paycom APIs to help you get started:

‍1. Does Paycom provide public APIs for direct integration?

• No, Paycom doesn’t offer public APIs. Instead, you can use services like Knit that provide pre-built integrations to access Paycom’s HR and payroll data.

2. What type of data can I retrieve through Paycom integrations?

• You can access employee details, payroll information, time and attendance records, benefits, and compliance reports through integrations.

3. Is custom API development required to integrate Paycom with my systems?

• No, using third-party platforms like Knit eliminates the need for custom API development by offering standardized, pre-built APIs for Paycom and other HR systems.

4. What security measures are in place for Paycom integrations?

• Third-party platforms such as Knit handle security by using data encryption and secure API access. They also comply with data privacy regulations like GDPR and HIPAA.

5. Can I automate employee onboarding and payroll using Paycom integrations?

• Yes, integrations with Paycom can automate employee onboarding and payroll processes, enabling seamless data transfer between Paycom and other HR or payroll systems.

‍

Get started with Paycom API

‍

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.

‍

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:

1. Seamless Integration: Easily connects with existing HR systems, CRMs, and other tools to streamline recruitment workflows.
2. Automation: Automates tasks such as syncing candidate data, managing job postings, and updating applicant status in real time.
3. Custom Endpoints: Provides flexible endpoints for candidates, jobs, opportunities, and interviews, allowing for tailored solutions.
4. Real-time Data: Offers real-time updates, ensuring your recruitment process stays up to date with minimal manual effort.
5. Well-documented: Comes with comprehensive documentation to help developers quickly build and maintain custom integrations.
6. Scalable: Supports businesses of all sizes, from startups to enterprises, helping them automate and improve their hiring processes.

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.

‍

Lever API Endpoints

‍

Here are the most commonly used API endpoints in the latest version -

‍

Applications

‍

• GET /opportunities/:opportunity/applications/:application
• GET /opportunities/:opportunity/applications

‍

Archive Reasons

• GET /archive_reasons/:archive_reason
• GET /archive_reasons

‍

Audit Events

• GET /audit_events

‍

Contacts

• GET /contacts/:contact
• PUT /contacts/:contact

‍

EEO (Equal Employment Opportunity Questions)

• GET /v1/eeo/responses/pii
• GET v1/eeo/responses

‍

Feedback

• GET /opportunities/:opportunity/feedback/:feedback
• GET /opportunities/:opportunity/feedback
• POST /opportunities/:opportunity/feedback
• PUT /opportunities/:opportunity/feedback/:feedback
• DELETE /opportunities/:opportunity/feedback/:feedback

‍

Feedback Template

• GET /feedback_templates/:feedback_template
• GET /feedback_templates
• POST /feedback_templates
• PUT /feedback_templates/:feedback_template
• DELETE /feedback_templates/:feedback_template

‍

Files

• POST /opportunities/:opportunity/files
• GET /opportunities/:opportunity/files/:file
• GET /opportunities/:opportunity/files
• GET /opportunities/:opportunity/files/:file/download
• DELETE /opportunities/:opportunity/files/:file

Interviews

• GET /opportunities/:opportunity/interviews/:interview
• GET /opportunities/:opportunity/interviews
• POST /opportunities/:opportunity/interviews
• PUT /opportunities/:opportunity/interviews/:interview
• DELETE /opportunities/:opportunity/interviews/:interview

‍

Note

• GET /opportunities/:opportunity/notes/:note
• GET /opportunities/:opportunity/notes
• POST /opportunities/:opportunity/notes
• DELETE /opportunities/:opportunity/notes/:noteId
• PUT /opportunities/:opportunity/notes/:note

‍

Offers

• GET /opportunities/:opportunity/offers
• GET /opportunities/:opportunity/offers/:offer/download

‍

Opportunity

• GET /opportunities/:opportunity
• GET /opportunities
• GET /opportunities/deleted
• POST /opportunities
• PUT /opportunities/:opportunity/stage
• PUT /opportunities/:opportunity/archived
• POST /opportunities/:opportunity/addLinks
• POST /opportunities/:opportunity/removeLinks
• POST /opportunities/:opportunity/addTags
• POST /opportunities/:opportunity/removeTags
• POST /opportunities/:opportunity/addSources
• POST /opportunities/:opportunity/removeSources

‍

Panels

• GET /opportunities/:opportunity/panels/:panel
• GET /opportunities/:opportunity/panels
• POST /opportunities/:opportunity/panels
• PUT /opportunities/:opportunity/panels/:panel
• DELETE /opportunities/:opportunity/panels/:panel

Posting

• GET /postings/:posting
• GET /postings
• POST /postings
• POST /postings/:posting
• GET /postings/:posting/apply
• POST /postings/:posting/apply

‍

Profile Form

• GET /opportunities/:opportunity/forms/:form
• GET /opportunities/:opportunity/forms
• POST /opportunities/:opportunity/forms
• GET /form_templates/:form_template
• GET /form_templates
• POST /form_templates
• PUT /form_templates/:form_template
• DELETE /form_templates/:form_template
• GET /opportunities/:opportunity/referrals/:referral
• GET /opportunities/:opportunity/referrals

‍

Requisition

• GET /requisitions/:requisition
• GET /requisitions
• POST /requisitions
• PUT /requisitions/:requisition
• DELETE /requisitions/:requisition

‍

Requisition Fields

• GET /requisition_fields/:requisition_field
• GET /requisition_fields
• POST /requisition_fields
• PUT /requisition_fields/:requisition_field
• POST /requisition_fields/:requisition_field/options
• PUT /requisition_fields/:requisition_field/options
• DELETE /requisition_fields/:requisition_field/options
• DELETE /requisition_fields/:requisition_field

‍

Resume

• GET /opportunities/:opportunity/resumes/:resume
• GET /opportunities/:opportunity/resumes
• GET /opportunities/:opportunity/resumes/:resume/download

‍

Sources

• GET /sources

‍

Stage

• GET /stages/:stage
• GET /stages

‍

Surveys

• GET /surveys/diversity/:posting

‍

Tags

• GET /tags

‍

Upload

• POST /uploads

‍

Users

• GET /users/:user
• GET /users
• POST /users
• PUT /users/:user
• POST /users/:user/deactivate
• POST /users/:user/reactivate

‍

Here’s a detailed reference to all the Lever API Endpoints.

‍

Lever API FAQs

‍

Here are the frequently asked questions about Lever APIs to help you get started:

‍

1. What is the difference between the Lever API and Postings API? Answer
2. Does the Lever API archive encompass all candidates either rejected or somehow stopped the interview process? Answer
3. Does each company customize stages in Lever API? Answer
4. How do I add global tags to a Lever account? Answer
5. Does each company customize tags in Lever? Answer
6. What are the rate limits for the Lever API? Answer
7. How can I get a sandbox account to test the Lever API? Answer

Find more FAQs here.

‍

‍Get started with Lever API

‍

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.

‍

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 - 

‍

1. Comprehensive Data Access: They provide seamless access to employee data, payroll, time management, and HR information.

‍

2. Custom Integrations: They enable the integration of UKG Pro features into custom applications for tailored solutions.

‍

3. Automation and Efficiency: They help to streamline workflows by automating HR processes like payroll and employee management.

‍

4. Real-Time Data: They provide real-time access to information, ensuring up-to-date data for decision-making.

‍

5. Secure and Scalable: They are built with robust security and scalability to support growing business needs.

‍

6. Developer-Friendly: They offer clear documentation and flexible endpoints to simplify development.

‍

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.

‍

UKG Pro API Endpoints

‍

Here are the most commonly used API endpoints in the latest version -

‍

Company Details

‍

• GET /configuration/v1/company-details

‍

Compensation Details

‍

• GET /personnel/v1/compensation-details
• GET /personnel/v1/companies/{companyId}/compensation-details
• GET /personnel/v1/companies/{companyId}/employees/{employeeId}/compensation-details
• GET /personnel/v1/compensation-details/{employeeId}

‍

Employee Deductions

‍

• GET /personnel/v1/emp-deductions

‍

Employee Change

‍

• GET /personnel/v1/employee-changes
• GET /personnel/v1/employee-changes/{employeeId}

‍

Employee Contact Details

‍

• GET /personnel/v1/contacts
• GET /personnel/v1/contacts/{contactId}

‍

Employee Contract Details

‍

• GET /personnel/v1/employee-contract-details

‍

Employee Demographic Details

‍

• GET /personnel/v1/employee-demographic-details

Employee Education Details

‍

• GET /personnel/v1/employee-education

‍

Employee Employment Details

‍

• GET /personnel/v1/employee-employment-details

‍

Employee Job History Details

‍

• GET /personnel/v1/employee-job-history-details
• GET /personnel/v1/employee-job-history-details/{systemId}

‍

Employee ID Lookup

‍

• POST /personnel/v1/employee-ids

‍

Employee Pay Statement

‍

• POST /payroll/v1/companies/pay-statements-summary
• POST /payroll/v1/companies/pay-statements
• POST /payroll/v1/employees/pay-statements
• POST /payroll/v1/employees/pay-statement/last
• POST /payroll/v1/employees/pay-statement/{PayIdentifier}

‍

Employment Details

‍

• GET /personnel/v1/employment-details
• GET /personnel/v1/companies/{companyId}/employment-details
• GET /personnel/v1/companies/{companyId}/employees/{employeeId}/employment-details

‍

Jobs Configuration

‍

• /configuration/v1/jobgroup
• /configuration/v1/jobs
• /configuration/v1/jobs/{code}

Person Details

‍

• GET /personnel/v1/person-details
• GET /personnel/v1/companies/{companyId}/person-details
• GET /personnel/v1/companies/{companyId}/employees/{employeeId}/person-details
• GET /personnel/v1/person-details/{employeeId}

‍

PTO Plans

‍

• GET /personnel/v1/pto-plans
• POST /personnel/v1/pto-plans
• PATCH /personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans/{ptoPlan}
• GET /personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans/{ptoPlan}
• GET /personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans

‍

Recruiting

‍

• GET /talent/recruiting/v2/{tenantalias}/api/applications
• POST /talent/recruiting/v2/{tenantalias}/api/applications
• GET /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}
• POST /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}/documents
• GET /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}/comments
• POST /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}/comments
• POST /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}/hire
• GET /talent/recruiting/v2/{tenantalias}/api/background-check-order-requests 
• POST /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/background-checks
• GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/background-checks
• GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/background-checks/{backgroundCheckId}
• PUT /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/background-checks/{backgroundCheckId}
• GET /talent/recruiting/v2/{tenantalias}/api/background-check-results-requests
• GET /talent/recruiting/v2/{tenantalias}/api/candidates
• POST /talent/recruiting/v2/{tenantalias}/api/candidates
• GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}
• GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/user-name-email
• POST /talent/recruiting/v2/{tenantalias}/api/candidates-lookup
• POST /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/documents
• GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/skills
• GET /talent/recruiting/v2/{tenantalias}/api/offers
• POST /talent/recruiting/v2/{tenantalias}/api/offers
• GET /talent/recruiting/v2/{tenantalias}/api/offers/{offerId}/offer-actions
• POST /talent/recruiting/v2/{tenantalias}/api/offers/{offerId}/submit-for-approval

‍

User Details

‍

• GET /personnel/v1/user-details

‍

Here’s a detailed reference to all the UKG Pro API Endpoints.

‍

UKG Pro API FAQs

‍

Here are the frequently asked questions about UKG Pro APIs to help you get started:

‍

1. How do I generate the API key for UKG? Answer
2. How to Configure Confidential Time Offs Accessible to Only Authorized Managers in UKG Ready? Answer
3. How to Retrieve Employee’s Pay Statement from UKG PRO? Answer
4. Authentication and Security for UKG PRO WFM (Dimensions) API Answer
5. How to Create an API Only User in UKG PRO WFM Answer
6. UKG Pro WFM Open Shift APIs: Creation, Scheduling, Dynamic Updates for Employee Removal, and Efficient Deletion Answer

‍

Find more FAQs here.

Get started with UKG Pro API

‍

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.

‍