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

• 1. Easy Data Access:
  • Seamlessly integrate with other HR tech systems to reduce manual data entry.
• 2. Automation:
  • Automate HR tasks to streamline workflows and improve data accuracy.
• 3. Custom Integration:
  • Supports custom integration to enhance operational efficiency.
• 4. Real-Time Sync:
  • Allows real-time data synchronization, particularly useful for time-off management.
• 5. Developer-Friendly:
  • Robust integration capabilities save developer time and effort.

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.

‍

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

• Easy Data Access:
  • Access HR data effortlessly with HiBob API's intuitive design.
• Automation:
  • Streamline HR tasks by automating repetitive processes.
• Custom Integration:
  • Tailor integrations to fit your unique business needs.
• Real-Time Sync:
  • Ensure data is always up-to-date with real-time synchronization.
• Strong Security:
  • Benefit from robust security measures to protect sensitive information.
• Scalable:
  • Handle unlimited integrations and data volumes with ease.
• Developer-Friendly:
  • Utilize comprehensive tools and documentation for seamless development.
• Global Support:
  • Receive support for international operations and diverse business environments.
• Data Transformation:
  • Likely supports transforming data to fit specific business requirements.
• Webhook Support:
  • Utilize webhooks for real-time notifications and updates.
• Sandbox Environment:
  • Test and develop safely in a dedicated sandbox environment.

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.

‍

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.

‍

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.

‍

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

• Easy Data Access
  • Facilitates straightforward data integration with enterprise applications.
• Automation
  • Supports workflow automation to streamline operations.
• Custom Integration
  • Allows for tailored solutions to meet specific business needs.
• Real-Time Sync
  • Ensures up-to-date information across systems.
• Strong Security
  • Implements robust security measures for data protection.
• Scalable
  • Supports business growth without technical limitations.
• Developer-Friendly
  • Offers comprehensive documentation and support.
• Global Support
  • Provides assistance to businesses worldwide.
• Error Handling and Logging
  • Includes features for efficient troubleshooting.
• Rate Limiting
  • Ensures fair usage and prevents abuse.
• Version Control
  • Manages changes and updates effectively.
• Data Transformation
  • Enables data manipulation and formatting.
• Webhook Support
  • Allows for event-driven integrations and notifications.
• Detailed Analytics and Reporting
  • Offers insights through analytics and reporting.
• Sandbox Environment
  • Provides a testing environment for development.

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

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.

‍

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.

‍

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

• 1. Easy Data Access:
  • Provides a comprehensive REST API platform with live documentation for seamless data integration.
• 2. Automation:
  • Supports automation of financial processes to improve efficiency.
• 3. Custom Integration:
  • Allows developers to build custom apps and integrations tailored to specific business needs.
• 4. Real-Time Sync:
  • Ensures data is synchronized in real-time across platforms.
• 5. Strong Security:
  • Utilizes OAuth 2.0 for secure authentication.
• 6. Scalable:
  • Offers scalable solutions to accommodate business growth.
• 7. Developer-Friendly:
  • Features comprehensive documentation and support for developers.
• 8. Global Support:
  • Provides world-class support for developers and businesses worldwide.
• 14. Detailed Analytics and Reporting:
  • Can generate detailed analytics and reports for business insights.
• 15. Sandbox Environment:
  • Provides a testing and development environment.

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

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.

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.

‍

Paychex is a payroll and HR solutions provider designed to simplify workforce management for businesses of all sizes. It offers a range of tools for payroll processing, employee benefits, time tracking, and compliance, helping companies streamline their HR tasks. 

‍

With Paychex’s API, developers can integrate payroll, benefits, and other HR data with external applications, enabling automation and creating a seamless experience for managing employee-related tasks across platforms.

‍

Here are some key highlights of the Paychex APIs:

1. Payroll Processing: Automate payroll calculations, deductions, and tax filings for smooth and timely payments.
2. Employee Management: Access and manage employee data, including personal details, employment status, and role-based permissions.
3. Time and Attendance: Track employee hours, manage time-off requests, and streamline attendance records for accurate payroll processing.
4. Benefits Administration: Integrate employee benefits data to easily manage enrollments, coverage updates, and compliance reporting.
5. Compliance and Tax Data: Access tax compliance data and generate reports to simplify filing and stay aligned with local, state, and federal regulations.
6. Secure Authentication: Uses OAuth 2.0 for secure data exchange, ensuring that sensitive payroll and employee information is protected.

In this article, we will explore what are the most commonly used Paychex API endpoints and how they allow businesses to streamline their HR and payroll operations, making it easy to integrate Paychex services into existing workflows.

‍

Paychex API Endpoints

‍

Here are the most commonly used Paychex API endpoints - 

‍

Authentication

‍

• POST https://api.paychex.com/auth/oauth/v2/token

Company

‍

• GET https://api.paychex.com/companies
• GET https://api.paychex.com/companies/{companyId}
• GET https://api.paychex.com/companies/{companyId}/calculationbases
• GET https://api.paychex.com/companies/{companyId}/contacttypes
• GET https://api.paychex.com/companies/{companyId}/customfields
• POST https://api.paychex.com/companies/{companyId}/customfields
• GET https://api.paychex.com/companies/{companyId}/customfields/{customFieldId}
• DELETE https://api.paychex.com/companies/{companyId}/customfields/{customfieldid}
• PATCH https://api.paychex.com/companies/{companyId}/customfields/{customfieldid}
• GET https://api.paychex.com/companies/{companyId}/customfieldscategories
• POST https://api.paychex.com/companies/{companyId}/customfieldscategories
• GET https://api.paychex.com/companies/{companyId}/customfieldscategories/{categoryId}
• DELETE https://api.paychex.com/companies/{companyId}/customfieldscategories/{categoryid}
• PATCH https://api.paychex.com/companies/{companyId}/customfieldscategories/{categoryid}
• GET https://api.paychex.com/companies/{companyId}/jobs
• POST https://api.paychex.com/companies/{companyId}/jobs
• GET https://api.paychex.com/companies/{companyId}/jobs/{jobId}
• PATCH https://api.paychex.com/companies/{companyId}/jobs/{jobId}
• GET https://api.paychex.com/companies/{companyId}/jobsegments
• GET https://api.paychex.com/companies/{companyId}/jobtitles
• GET https://api.paychex.com/companies/{companyId}/jobtitles/{jobTitleId}
• GET https://api.paychex.com/companies/{companyId}/laborassignments
• GET https://api.paychex.com/companies/{companyId}/laborassignments/{laborAssignmentId}
• GET https://api.paychex.com/companies/{companyId}/locations
• GET https://api.paychex.com/companies/{companyId}/locations/{locationId}
• GET https://api.paychex.com/companies/{companyId}/organizations
• GET https://api.paychex.com/companies/{companyId}/organizations/{orgId}
• GET https://api.paychex.com/companies/{companyId}/payfrequencies
• GET https://api.paychex.com/companies/{companyId}/workers
• POST https://api.paychex.com/companies/{companyId}/workers
• GET https://api.paychex.com/companies/{companyId}/workerstatuses
• GET https://api.paychex.com/companies/{companyId}/workerstatuses/{statusId}

‍

Payroll

‍

• GET https://api.paychex.com/companies/{companyId}/checks
• POST https://api.paychex.com/companies/{companyId}/checks
• GET https://api.paychex.com/companies/{companyId}/paycomponents
• GET https://api.paychex.com/companies/{companyId}/paycomponents/{paycomponentId}
• GET https://api.paychex.com/companies/{companyId}/payperiods
• GET https://api.paychex.com/companies/{companyId}/payperiods/{payperiodId}
• GET https://api.paychex.com/workers/{workerId}/checks
• POST https://api.paychex.com/workers/{workerId}/checks
• GET https://api.paychex.com/workers/{workerId}/checks/{externalCheckId}
• DELETE https://api.paychex.com/workers/{workerId}/checks/{externalCheckId}
• DELETE https://api.paychex.com/checks
• POST https://api.paychex.com/checks/{checkId}/checkcomponents
• DELETE https://api.paychex.com/checks/{checkId}/checkcomponents/{checkComponentId}
• PATCH https://api.paychex.com/checks/{checkId}/checkcomponents/{checkComponentId}

‍

Worker

• GET https://api.paychex.com/workers/{workerId}
• DELETE https://api.paychex.com/workers/{workerId}
• PATCH https://api.paychex.com/workers/{workerId}
• GET https://api.paychex.com/workers/{workerId}/assignmentdistributions
• GET https://api.paychex.com/workers/{workerId}/communications
• POST https://api.paychex.com/workers/{workerId}/communications
• GET https://api.paychex.com/workers/{workerId}/communications/{communicationId}
• DELETE https://api.paychex.com/workers/{workerId}/communications/{communicationId}
• PATCH https://api.paychex.com/workers/{workerId}/communications/{communicationId}
• GET https://api.paychex.com/workers/{workerId}/compensation
• GET https://api.paychex.com/workers/{workerId}/compensation/payrates
• POST https://api.paychex.com/workers/{workerId}/compensation/payrates
• GET https://api.paychex.com/workers/{workerId}/compensation/payrates/{rateId}
• DELETE https://api.paychex.com/workers/{workerId}/compensation/payrates/{rateId}
• PATCH https://api.paychex.com/workers/{workerId}/compensation/payrates/{rateId}
• GET https://api.paychex.com/workers/{workerId}/compensation/paystandards
• GET https://api.paychex.com/workers/{workerId}/contacts
• POST https://api.paychex.com/workers/{workerId}/contacts
• GET https://api.paychex.com/workers/{workerId}/contacts/{contactId}
• DELETE https://api.paychex.com/workers/{workerId}/contacts/{contactId}
• PATCH https://api.paychex.com/workers/{workerId}/contacts/{contactId}
• GET https://api.paychex.com/workers/{workerId}/customfields
• POST https://api.paychex.com/workers/{workerId}/customfields
• GET https://api.paychex.com/workers/{workerId}/customfields/{workerCustomFieldId}
• DELETE https://api.paychex.com/workers/{workerId}/customfields/{workerCustomFieldId}
• PATCH https://api.paychex.com/workers/{workerId}/customfields/{workerCustomFieldId}
• GET https://api.paychex.com/workers/{workerId}/directdeposits
• POST https://api.paychex.com/workers/{workerId}/directdeposits
• PATCH https://api.paychex.com/workers/{workerId}/directdeposits
• GET https://api.paychex.com/workers/{workerId}/directdeposits/{directDepositId}
• DELETE https://api.paychex.com/workers/{workerId}/directdeposits/{directDepositId}
• PATCH https://api.paychex.com/workers/{workerId}/directdeposits/{directDepositId}
• GET https://api.paychex.com/workers/{workerId}/federaltax
• POST https://api.paychex.com/workers/{workerId}/federaltax
• DELETE https://api.paychex.com/workers/{workerId}/federaltax
• PATCH https://api.paychex.com/workers/{workerId}/federaltax
• GET https://api.paychex.com/workers/{workerId}/federaltax
• POST https://api.paychex.com/workers/{workerId}/paycomponents
• PATCH https://api.paychex.com/workers/{workerId}/paycomponents
• GET https://api.paychex.com/workers/{workerId}/paycomponents/{workerComponentId}
• DELETE https://api.paychex.com/workers/{workerId}/paycomponents/{workerComponentId}
• PATCH https://api.paychex.com/workers/{workerId}/paycomponents/{workerComponentId}
• GET https://api.paychex.com/workers/{workerId}/status
• GET https://api.paychex.com/workers/{workerId}/timeoff

‍

Management

• POST https://api.paychex.com/management/requestclientaccess

‍

Webhooks

• GET https://api.paychex.com/management/domains
• GET https://api.paychex.com/management/hooks
• POST https://api.paychex.com/management/hooks
• GET https://api.paychex.com/management/hooks/{hookId}
• DELETE https://api.paychex.com/management/hooks/{hookId}

‍

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

Paychex API FAQs

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

‍

1. Do Paychex APIs support pagination? Answer
2. What is the rate limit on Paychex API endpoints? Answer
3. What happens when I POST new workers via the Paychex API, and what are the required fields? Answer
4. How do I specify a vendor media type profile in Paychex API requests, and is it required for each call? Answer
5. What are the predefined headers used in Paychex API requests and responses? Answer

Find more FAQs here.

‍

Get started with Paychex API

‍

To access Paychex APIs, create a Paychex account and log in to the Developer Portal. Apply for API access, and upon approval, you'll receive your API credentials (client ID and secret). Use these for OAuth 2.0 authentication to securely access the API endpoints. Review the documentation for integration guidelines.

‍

If you’re looking for a quick way to connect multiple Payroll systems, consider using Knit—a single API solution that integrates with major platforms, streamlining your setup and reducing development time. To sign up for free, click here. To check the pricing, see our pricing page.

‍

‍

Sage Intacct is a cloud-based accounting system designed to help businesses manage their finances more efficiently. It automates essential tasks, provides real-time financial insights, and scales with business growth. 

‍

In addition to its core features, Sage Intacct offers powerful APIs that allow seamless integration with other tools and customizable workflows. These APIs enable businesses to automate invoicing, reporting, and payment processing, further enhancing operational efficiency. 

‍

Key highlights of Sage Intacct APIs are as follows:

1. Seamless Integration: You can easily connect Sage Intacct with other business tools like CRM, payroll, or ERP systems for smooth data exchange.
2. Automation: These APIs help you automate financial tasks such as invoicing, payment processing, and reporting, reducing manual effort and errors.
3. Custom Workflows: They help you create tailored workflows to fit your business needs, enhancing operational efficiency and flexibility.
4. Real-Time Data Access: They can be used to access and update financial data in real-time, ensuring accurate and up-to-date information across systems.
5. Scalability: These APIs support growing businesses, allowing for the expansion of financial operations without disruptions.
6. Extensive Documentation: Sage Intacct provides detailed API documentation that makes it easier for developers to integrate and build custom solutions.

In this article, we’ll explore how Sage Intacct’s APIs can streamline your financial operations, enhance flexibility, and highlight the most commonly used endpoints.

‍

Sage Intacct API Endpoints

‍

Sage Intacct primarily uses a SOAP API for its integrations. The API follows the SOAP protocol and relies on XML for request and response formats, which provides structured and standardized communication. While this means it’s a bit more complex to implement compared to REST APIs, it’s highly secure and reliable, making it well-suited for handling sensitive financial data.

‍

Here are the commonly used Sage Intacct API endpoints, categorized by function:

‍

General Ledger

• Accounts: GLACCOUNT
• Journal Entries: GLBATCH
• Statistical Journal Entries: STATGLBATCH

Accounts Receivable

• Customers: CUSTOMER
• Customer Invoices: ARINVOICE
• Customer Payments: ARPYMT
• Credit Memos: ARADJ

Accounts Payable

• Vendors: VENDOR
• Vendor Bills: APBILL
• Vendor Payments: APPYMT
• Debit Memos: APADJ

Cash Management

• Payments: CMTRANSACTION
• Deposits: CMDEPOSIT
• Charge Card Transactions: CHARGECARD

Project Management

• Projects: PROJECT
• Tasks: TASK
• Project Time Entries: TIMESHEET
• Project Expenses: EXPENSES

Employee Expenses

• Expense Reports: EXPENSEREPORT
• Expense Types: EXPENSETYPE

Order Entry (for Sales and Inventory)

• Sales Orders: SALESORDER
• Inventory Items: INVENTORYITEM
• Inventory Transactions: ICTRANSACTION

Reporting

• Reports: getFinancialReport, getReport

Purchasing

• Purchase Orders: PURCHASEORDER
• Receiving Transactions: RECEIVE

Contracts and Subscriptions

• Contracts: CONTRACT
• Contract Line Items: CONTRACTLINE
• Revenue Recognition Schedules: REVENUESCHEDULE

Inventory and Warehousing

• Warehouse Locations: LOCATION
• Inventory Control: ICITEM
• Inventory Adjustments: ICADJUSTMENT
• Inventory Transfers: ICTRANSFER

Purchasing and Vendor Management

• Vendor Types: VENDTYPE
• Purchase Requisitions: PURCHASEREQUISITION
• Vendor Expense Requests: APADJ

Fixed Assets

• Fixed Assets: ASSET
• Asset Depreciation: DEPRECIATION
• Asset Disposals: ASSETDISPOSAL
• Asset Transfers: ASSETTRANSFER

Banking and Cash Management

• Bank Accounts: BANKACCOUNT
• Bank Reconciliation: RECONCILIATION
• Bank Deposits: BANKDEPOSIT

Human Resources

• Employees: EMPLOYEE
• Employee Time: TIMESHEETENTRY
• Payroll Details: (Integration with payroll systems required)

Tax Management

• Tax Details: TAXDETAIL
• Tax Jurisdictions: TAXJURISDICTION
• Tax Groups: TAXGROUP

Miscellaneous and System-Level

• Attachments: ATTACHMENTS (for managing document attachments across modules)
• Custom Objects: getCustomObject (for custom modules or objects set up within Sage Intacct)
• User Permissions and Roles: USERPERMISSIONS, USERROLE

These additional endpoints provide extensive support for more complex financial, HR, tax, and asset management tasks, allowing businesses to integrate Sage Intacct across diverse operations.

‍

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

‍

Sage Intacct API FAQs

‍

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

‍

1. How do I verify/troubleshoot my API calls? Answer
2. Can I update a statistical journal entry via the API? Answer
3. Are there any volume limits around the Intacct API? Answer
4. Does Sage Intacct support Pagination? Answer
5. What return format should I use for best results when using readByQuery and readMore? Answer

Find more FAQs here.

‍

Get started with Sage Intacct API

‍

Sage Intacct API access is available for integration after a thorough internal review to ensure alignment with your business needs. However, if you’re looking to quickly connect with multiple HR, Accounting, CRM, and more integrations consider using Knit—a single API solution that integrates with all major HR platforms, simplifying your setup process.

‍

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

‍

Adobe Sign, introduced in 2006 as part of Adobe's comprehensive suite of document management solutions, has transformed the way businesses handle electronic signatures and document workflows. 

‍

With Adobe Sign APIs, developers can access powerful tools that enable seamless integration of e-signature capabilities into their applications, providing a secure and efficient way to manage digital transactions.

‍

Key highlights of Adobe Sign APIs are as follows:

‍

1. Comprehensive Document Management: It automates the entire document lifecycle, from creation and distribution to signing and archiving.

‍

2. Real-time Tracking and Notifications: It helps to monitor the status of documents in real time, receiving instant updates on signatory actions.

‍

3. Robust Security and Compliance: It ensures that all electronic signatures are legally binding and compliant with industry standards such as GDPR, eIDAS, and HIPAA.

‍

4. Seamless Integration: It is easy to integrate with popular platforms like Microsoft Office 365, Salesforce, and other CRM and ERP systems, enhancing productivity and collaboration.

‍

5. Customizable Workflows: It helps to tailor the signing process to fit specific business needs, incorporating custom branding and user experiences.

‍

In this article, we'll provide an overview of the Adobe Sign API endpoints.

‍

Adobe Sign API Endpoints

‍

While there are several Adobe Sign API endpoints, here are the most commonly used ones in the latest version:

‍

Transient Documents

‍

These endpoints are used to upload a document, get its document ID, and get the requested views for that document.

‍

• POST /transientDocuments
• POST /transientDocuments/{transientDocumentId}/views

‍

Agreements

‍

These are used to create, send, and manage agreements and documents for e-signature.

‍

• POST /agreements
• POST /agreements/{agreementId}/members/participantSets/{participantSetId}/delegatedParticipantSets
• POST /agreements/{agreementId}/members/share
• POST /agreements/{agreementId}/reminders
• GET /agreements
• GET /agreements/{agreementId}
• GET /agreements/{agreementId}/auditTrail
• GET /agreements/{agreementId}/documents
• GET /agreements/{agreementId}/reminders
• GET /agreements/{agreementId}/members
• GET /agreements/{agreementId}/members/participantSets/{participantSetId}
• GET /agreements/{agreementId}/shares
• PUT /agreements/{agreementId}/me/visibility
• PUT /agreements/{agreementId}/members/participantSets/{participantSetId}
• DELETE /agreements/{agreementId}/documents
• DELETE /agreements/{agreementId}/shares

‍

Users

‍

These are used to manage user accounts, permissions, and roles within the Adobe Sign system.

‍

• POST /users
• POST /users/{userId}/views
• GET /users
• GET /users/{userId}
• GET /users/{userId}/events
• PUT /users/{userId}
• PUT /users/{userId}/locale
• PUT /users/{userId}/state

‍

Library Documents

‍

These help to create and manage template documents that can be reused for multiple agreements.

‍

• POST /libraryDocumentsCreates
• POST /libraryDocuments/{libraryDocumentId}/views
• GET /libraryDocuments
• GET /libraryDocuments/{libraryDocumentId}
• GET /libraryDocuments/{libraryDocumentId}/auditTrail
• GET /libraryDocuments/{libraryDocumentId}/events
• GET /libraryDocuments/{libraryDocumentId}/members
• PUT /libraryDocuments/{libraryDocumentId}

‍

Search

‍

This API helps to retrieve, search, filter, and sort agreements for the user.

‍

• POST /search

‍

Workflows 

‍

These APIs help to automate and manage multi-step signing processes and workflows.

‍

• GET /workflows
• GET /workflows/{workflowId}

‍

MessageTemplates

‍

These APIs help to retrieve a list of message templates applicable to the current user.

‍

• GET /messageTemplates

‍

MegaSigns

‍

These APIs help to send a single document to multiple recipients for individual signatures.

‍

• POST /megaSigns
• POST /megaSigns/{megaSignId}/members/share
• POST /megaSigns/{megaSignId}/reminders
• POST /megaSigns/{megaSignId}/views
• GET /megaSigns
• GET /megaSigns/{megaSignId}
• GET /megaSigns/{megaSignId}/agreements
• GET /megaSigns/{megaSignId}/documents
• GET /megaSigns/{megaSignId}/documents/imageUrls
• GET /megaSigns/{megaSignId}/documents/{documentId}
• GET /megaSigns/{megaSignId}/events
• GET /megaSigns/{megaSignId}/members
• GET /megaSigns/{megaSignId}/reminders
• GET /megaSigns/{megaSignId}/reminders/{reminderId}
• PUT /megaSigns/{megaSignId}

‍

Webhooks

‍

These APIs help to create and manage webhooks.

‍

• POST /webhooks
• GET /webhooks
• GET /webhooks/{webhookId}
• PUT /webhooks/{webhookId}
• PUT /webhooks/{webhookId}/state
• DELETE /webhooks/{webhookId}

Here’s a detailed reference to all the Adobe Sign APIs.

‍

Adobe Sign API FAQs

‍

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

‍

1. How to customize Signature fields in Document using adobe sign API? Answer
2. How to create a widget with pre-filling details? Answer
3. Adobe Sign access token invalid_request Answer
4. Attached pdf in the email is base64 encoded and does not show the actual PDF Answer
5. Adobe Sign API password protection not working Answer

‍

Get started with Adobe Sign API

‍

Adobe Sign API access is reserved exclusively for enterprise and developer tier accounts. However, if you want to integrate with multiple HRMS or Recruitment APIs quickly, you can get started with Knit, one API for all top HR integrations.

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

Find more FAQs here.

‍

Zoho Desk is a powerful, cloud-based customer service software designed to streamline support operations and enhance customer satisfaction. As part of the Zoho suite, Zoho Desk empowers businesses to manage customer queries across multiple channels—email, social media, chat, and more—through a unified platform. It offers features like ticket management, workflow automation, and detailed analytics, helping support teams stay organized and efficient.

‍

With the Zoho Desk API, developers can take things a step further by connecting Zoho Desk with other tools, automating tasks, and customizing workflows. 

‍

Key highlights of Zoho Desk API are as follows - 

‍

1. Multi-Channel Ticket Management: These APIs help you to access and manage tickets from multiple channels, like email, chat, and social media, through a single API.
2. Workflow Automation: These endpoints can automate repetitive tasks, such as ticket assignments and status updates, to improve response times and team efficiency.
3. Custom Integrations: These APIs help to connect Zoho Desk with other apps, CRMs, or systems to create a unified customer support experience.
4. Advanced Reporting: These APIs help to retrieve data for performance tracking, including response times, ticket trends, and customer satisfaction metrics.
5. Custom Fields and Modules: These APIs help to extend Zoho Desk functionality with custom fields and modules tailored to your business needs.
6. Real-Time Updates: These APIs can be used to get instant notifications for ticket changes, comments, and other updates using webhooks.
7. Secure Authentication: Zoho Desk APIs use OAuth 2.0 for secure access, ensuring data safety and privacy.

‍

In this article, we’ll explore the key Zoho Desk API endpoints and how they can provide flexibility to build powerful, custom solutions that enhance your customer service capabilities.

‍

Zoho Desk API Endpoints

‍

Zoho Desk APIs make it easy to connect with other Zoho apps and external tools by using RESTful principles. With these APIs, you can automatically get and update data in various parts of Zoho Desk, like Tickets, Contacts, and Accounts. All the APIs follow standard HTTP rules and use error codes for better understanding.

‍

Here are the most commonly used Zoho Desk API endpoints - 

‍

Organizations

‍

• GET /api/v1/organizations/{organization_Id}
• GET /api/v1/organizations
• GET /api/v1/accessibleOrganizations
• PATCH /api/v1/organizations/{organization_Id}
• GET /api/v1/organizations/{organization_Id}/logo
• GET /api/v1/organizations/{organization_Id}/favicon
• POST /api/v1/organizations/{organization_Id}/logo
• POST /api/v1/organizations/{organization_Id}/favicon
• DELETE /api/v1/organizations/{organization_Id}/logo
• DELETE /api/v1/organizations/{organization_Id}/favicon
• POST /api/v1/organizations/markDefault

‍

Agents

‍

• GET /api/v1/agents/{agent_id}
• GET /api/v1/agents
• GET /api/v1/agents/count
• GET /api/v1/agentsByIds?agentIds={agent_ids}
• GET /api/v1/myinfo
• POST /api/v1/agents/activate
• POST /api/v1/agents/{agent_id}/deactivate
• POST /api/v1/agents/reinvite
• POST /api/v1/agents
• PATCH /api/v1/agents/{agent_id}
• POST /api/v1/agents/deleteUnconfirmed
• POST /api/v1/agents/{agent_id}/delete
• POST /api/v1/deletedAgents/{agent_id}/anonymize
• POST /api/v1/uploadMyPhoto
• GET /api/v1/agents/{agent_id}/photo?orgId={org_id}
• POST /api/v1/deleteMyPhoto
• GET /api/v1/myPreferences
• PATCH /api/v1/myPreferences
• GET /api/v1/agents/email/{email}
• POST /api/v1/agents/{agent_id}/reassignment

‍

Profiles

‍

• GET /api/v1/profiles
• GET /api/v1/profiles/count
• GET /api/v1/profiles/{profile_id}
• POST /api/v1/profiles/{profile_id}/clone
• PATCH /api/v1/profiles/{profile_id}
• POST /api/v1/profiles/{profile_id}/delete
• GET /api/v1/myProfile
• GET /api/v1/myProfilePermissions
• GET /api/v1/profiles/{profile_id}/agents
• GET /api/v1/lightAgentProfile

‍

Roles

‍

• GET /api/v1/roles
• GET /api/v1/roles/{role_id}/agents
• POST /api/v1/roles
• PATCH /api/v1/roles/{role_id}
• POST /api/v1/roles/{role_id}/delete
• GET /api/v1/roles/{role_id}
• GET /api/v1/roles/count
• GET /api/v1/personalRole
• GET /api/v1/rolesByIds

‍

Teams

‍

• POST /api/v1/teams
• PATCH /api/v1/teams/{team_id}
• POST /api/v1/teams/{team_id}/deleteTeam
• GET /api/v1/teams/{team_id}
• GET /api/v1/teams
• GET /api/v1/teams/{team_id}/members
• GET /api/v1/teams/{team_id}/associables
• GET /api/v1/agents/{agent_id}/teams
• GET /api/v1/roles/{role_id}/teams
• GET /api/v1/departments/{department_id}/teams

‍

Departments

• GET /api/v1/departments/{department_id}
• GET /api/v1/departments
• GET /api/v1/departments/{department_id}/agents
• GET /api/v1/departments/count
• GET /api/v1/departmentsByIds?departmentIds={department_ids}
• GET /api/v1/departments/checkExists
• POST /api/v1/departments
• PATCH /api/v1/departments/{department_id}
• POST /api/v1/departments/{department_id}/disable
• POST /api/v1/departments/{department_id}/enable
• POST /api/v1/departments/{department_id}/associateAgents
• POST /api/v1/departments/{department_id}/dissociateAgents
• GET /api/v1/departments/{department_id}/logo
• POST /api/v1/departments/{department_id}/logo
• DELETE /api/v1/departments/{department_id}/logo

Channels

• GET /api/v1/channels

Tickets

• GET /api/v1/tickets/{ticket_id}
• GET /api/v1/tickets
• GET /api/v1/tickets/archivedTickets
• GET /api/v1/associatedTickets
• POST /api/v1/tickets
• PATCH /api/v1/tickets/{ticket_id}
• POST /api/v1/tickets/moveToTrash
• POST /api/v1/tickets/deleteSpam
• POST /api/v1/tickets/{ticket_id}/merge
• POST /api/v1/tickets/{ticket_id}/move
• POST /api/v1/tickets/{ticket_id}/threads/{thread_id}/split
• POST /api/v1/tickets/updateMany
• POST /api/v1/closeTickets
• POST api/v1/tickets/{ticket_id}/markAsRead
• POST api/v1/tickets/{ticket_id}/markAsUnRead
• POST /api/v1/tickets/markSpam
• GET api/v1/ticketQueueView/count
• GET api/v1/agentsTicketsCount
• GET api/v1/tickets/{ticket_id}/History
• GET api/v1/tickets/{ticket_id}/resolution
• GET api/v1/tickets/{ticket_id}/resolutionHistory
• PATCH api/v1/tickets/{ticket_id}/resolution
• DELETE api/v1/tickets/{ticket_id}/resolution
• GET /api/v1/tickets/([0-9]+)/metrics
• POST /api/v1/tickets/emptySpam
• POST /api/v1/tickets/{ticket_id}/executeSkillbasedAssignment
• POST /api/v1/tickets/{ticket_id}/recalculateSkills
• GET /api/v1/tickets/{ticket_id}/articleSuggestion

Thread

• GET /api/v1/tickets/{ticket_id}/threads/{thread_id}
• GET /api/v1/tickets/{ticket_id}/threads/{thread_id}/originalContent
• GET /api/v1/tickets/{ticket_id}/latestThread
• POST /api/v1/tickets/{ticket_id}/threads/{thread_id}/sendForReview
• GET /api/v1/tickets/{ticket_id}/threads
• GET /api/v1/tickets/{ticket_id}/conversations
• POST /api/v1/tickets/{ticket_id}/sendReply
• POST /api/v1/tickets/{ticket_id}/draftReply
• PATCH /api/v1/tickets/{ticket_id}/draftReply/{thread_id}
• DELETE /api/v1/tickets/{ticket_id}/threads/{thread_id}/attachments/{attachment_id}

Contacts

• GET /api/v1/contacts/{contact_id}
• GET /api/v1/contacts
• POST /api/v1/contacts
• PATCH /api/v1/contacts/{contact_id}
• POST /api/v1/contacts/moveToTrash
• POST /api/v1/contacts/deleteSpam
• GET /api/v1/contacts/{contact_id}/profiles
• POST /api/v1/contacts/updateMany
• GET /api/v1/contacts/contactsByIds
• GET /api/v1/contacts/{contact_id}/tickets
• GET /api/v1/contacts/{contact_id}/products
• GET api/v1/contacts/count
• GET /api/v1/contacts/{contact_id}/statistics
• POST /api/v1/contacts/{contact_id}/merge
• POST /api/v1/contacts/markSpam
• POST api/v1/contacts/{contact_id}/associateProducts
• GET api/v1/contacts/{contact_id}/history
• POST api/v1/contacts/inviteAsEndUser
• POST api/v1/contacts/{contact_id}/inviteAsEndUser
• DELETE api/v1/contacts/{contact_id}/photo
• GET api/v1/contacts/{contact_id}/helpCenters
• GET /api/v1/contacts/{contact_id}/accounts
• POST api/v1/contacts/{contact_id}/associateAccounts
• POST api/v1/contacts/{contact_id}/dissociateAccounts
• POST /api/v1/contacts/{contact_id}/approveEndUserInvite
• POST /api/v1/contacts/{contact_id}/rejectEndUserInvite

Accounts

• GET /api/v1/accounts/{account_id}
• GET /api/v1/accounts
• POST /api/v1/accounts
• PATCH /api/v1/accounts/{account_id}
• POST /api/v1/accounts/moveToTrash
• GET /api/v1/accounts/{account_id}/contracts
• GET api/v1/contracts/count
• GET api/v1/accounts/count
• GET api/v1/accounts/{accounts_id}/contacts?from={from}&limit={limit}&sortBy={sortingField}
• GET /api/v1/accounts/{account_id}/tickets
• GET /api/v1/accounts/{account_id}/products
• POST /api/v1/accounts/{account_id}/merge
• POST api/v1/accounts/{account_id}/associateProducts
• POST /api/v1/accounts/updateMany
• GET api/v1/accounts/{account_id}/history
• GET /api/v1/accounts/([0-9]+)/statistics
• GET /api/v1/accounts/{account_id}/sla
• POST /api/v1/accounts/{account_id}/sla/{sla_id}

Account Contact Mapping

• PATCH /api/v1/accountContactMapping/{mapping_id}

Tasks

• GET /api/v1/tasks/{task_id}
• GET /api/v1/tasks
• POST /api/v1/tasks
• PATCH /api/v1/tasks/{task_id}
• POST /api/v1/tasks/moveToTrash
• POST /api/v1/tasks/deleteSpam
• GET /api/v1/tickets/{ticket_id}/tasks
• GET /api/v1/tasks/count
• POST /api/v1/tasks/updateMany
• POST /api/v1/tasks/emptySpam

‍

Products

• GET /api/v1/products/{product_id}
• GET /api/v1/products
• POST /api/v1/products
• GET /api/v1/products/{product_id}/tickets
• PATCH /api/v1/products/{product_id}
• POST /api/v1/products/moveToTrash
• GET /api/v1/products/searchDuplicates
• POST api/v1/products/{product_id}/associateContacts
• POST api/v1/products/{product_id}/associateAccounts
• GET api/v1/products/{products_id}/accounts
• GET api/v1/products/{products_id}/contacts

Users

• GET /api/v1/users
• GET /api/v1/users/{user_id}
• PATCH /api/v1/users/{user_id}
• POST api/v1/users/{user_id}/anonymize
• GET /api/v1/users/{user_id}/groups
• POST /api/v1/users/{user_id}/groups/associate
• POST /api/v1/users/{user_id}/groups/dissociate
• GET /api/v1/users/{user_id}/labels
• POST /api/v1/users/{user_id}/labels/assign
• POST /api/v1/users/{user_id}/labels/remove
• GET /api/v1/users/([0-9]+)/badges
• POST /api/v1/users/{user_id}/badges/associate
• POST /api/v1/users/{user_id}/badges/dissociate

Contracts

• GET api/v1/contracts/{{contract_id}}
• GET api/v1/contracts
• POST /api/v1/contracts
• PATCH /api/v1/contracts/{contract_id}
• POST api/v1/contracts/moveToTrash
• POST /api/v1/contracts/updateMany

Upload

• POST /api/v1/uploads

Activities

• GET /api/v1/tickets/{ticket_id}/activities
• POST /api/v1/activities/emptySpam

‍

Calls

• GET api/v1/calls/{call_id}
• GET api/v1/calls
• POST api/v1/calls
• PATCH api/v1/calls/{call_id}
• GET /api/v1/tickets/{ticket_id}/calls
• POST /api/v1/calls/moveToTrash
• POST /api/v1/calls/deleteSpam
• POST /api/v1/calls/{call_id}/clearLiveCall
• POST /api/v1/calls/updateMany
• POST /api/v1/calls/emptySpam

‍

Events

• GET api/v1/events/{event_id}
• GET api/v1/events
• POST api/v1/events
• PATCH api/v1/events/{event_id}
• GET /api/v1/tickets/{ticket_id}/events
• POST /api/v1/events/moveToTrash
• POST /api/v1/events/deleteSpam
• POST /api/v1/events/updateMany
• POST /api/v1/events/emptySpam

Skills

• POST /api/v1/skills
• GET /api/v1/skills/{skillId}
• PATCH /api/v1/skills/{skillId}
• DELETE /api/v1/skills/{skillId}
• GET /api/v1/skills
• GET /api/v1/skills/{skillId}/relatedRules
• POST /api/v1/skills/order
• GET /api/v1/agents/{agentId}/skills
• POST /api/v1/agents/{agentId}/mapSkills
• GET /api/v1/skills/criteriaFields

‍

Subscriptions

• GET /subscriptions
• POST /subscriptions
• GET /subscriptions/{subscriptionId}
• PUT /subscriptions/{subscriptionId}
• DELETE /subscriptions/{subscriptionId}

Time Entries

• GET /timeentries
• POST /timeentries
• GET /timeentries/{entryId}
• PUT /timeentries/{entryId}
• DELETE /timeentries/{entryId}

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

‍

Zoho Desk API FAQs

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

‍

1. What is the usage limit of Zoho API? Answer
2. How does the get Ticket History API work? Answer
3. What are the events supported in the Get Ticket History API? Answer
4. How to authenticate calls from a Zoho Desk Extension using a custom API key? Answer
5. How to get Access Token for Client Based Application for Zoho API? Answer

Find more FAQs here.

‍

‍Get started with Zoho Desk API

‍

To access the Zoho Desk API, you'll need a Zoho account and an API key, which you can obtain from the Zoho Developer Console. After logging into your Zoho account, navigate to the API Console to create a new client and get your client ID and client secret. Zoho Desk uses OAuth 2.0 for secure authentication, so you’ll authorize the app to generate access tokens. Once authenticated, you’ll have access to Zoho Desk’s API endpoints to start building and integrating with your applications.

‍

If you’re looking for a quick way to connect multiple customer service or CRM systems, consider using Knit—a single API solution that integrates with major platforms, streamlining your setup and reducing development time. To sign up for free, click here. To check the pricing, see our pricing page.

‍

QuickBooks is an easy-to-use accounting software that helps small and medium-sized businesses manage their finances. It offers tools for invoicing, tracking expenses, handling payroll, and preparing taxes, all in one place. 

‍

With QuickBooks Online APIs, whether you’re launching a new business or have been running one for years, managing your finances becomes easier and more efficient. 

‍

Key highlights of QuickBooks Online APIs:

‍

1. Easy Data Access: Helps to connect and access your financial data like transactions, invoices, and reports easily with other apps.

‍

2. Automation: Let’s you automate tasks like invoicing and expense tracking to save time and reduce errors.

‍

3. Custom Integration: You can easily integrate QuickBooks with other tools and create custom solutions to fit your business needs.

‍

4. Real-Time Sync: It helps you keep your data up-to-date across platforms with real-time synchronization.

‍

5. Strong Security: It helps you protect your financial data with secure authentication and authorization.

‍

6. Scalable: As your business grows, QuickBooks APIs can handle more transactions and complexity.

‍

7. Developer-Friendly: Clear documentation and support make it easier for developers to work with the APIs.

‍

8. Global Support: Works with different currencies, tax systems, and languages, making it great for businesses around the world.

‍

While we have covered the Quickbooks Online API in depth earlier, in this article, we'll provide an overview of the QuickBooks Online API endpoints.

‍

QuickBooks Online API Endpoints

‍

While there are several QuickBooks Online API endpoints, here are the most commonly used ones:

‍

1. Customer Endpoint (/customer)some text
   • /customer/{customer_id}/balance: Retrieve the current balance of a specific customer.
   • /customer/{customer_id}/creditmemo: Manage credit memos associated with a customer.
   • /customer/{customer_id}/estimate: Handle estimates or quotes for a customer.
2. Invoice Endpoint (/invoice)some text
   • /invoice/{invoice_id}/send: Send an invoice to a customer via email.
   • /invoice/{invoice_id}/payment: Retrieve payment details associated with a specific invoice.
   • /invoice/{invoice_id}/refundreceipt: Create or manage refund receipts for a specific invoice.
3. Payment Endpoint (/payment)some text
   • /payment/{payment_id}/apply: Apply a payment to specific invoices or other transactions.
   • /payment/{payment_id}/unapplied: Retrieve payments that have not yet been applied to invoices.
4. Sales Receipt Endpoint (/salesreceipt)some text
   • /salesreceipt/{salesreceipt_id}/email: Send a sales receipt to a customer via email.
   • /salesreceipt/{salesreceipt_id}/payment: Retrieve payment details related to a sales receipt.
5. Bill Endpoint (/bill)some text
   • /bill/{bill_id}/payment: Manage payments made against a specific bill.
   • /bill/{bill_id}/attachment: Attach documents, such as receipts, to a bill.
6. Vendor Endpoint (/vendor)some text
   • /vendor/{vendor_id}/purchaseorder: Manage purchase orders associated with a vendor.
   • /vendor/{vendor_id}/bill: Retrieve bills linked to a specific vendor.
7. Expense Endpoint (/purchase)some text
   • /purchase/{purchase_id}/receipt: Attach and manage receipts related to a specific purchase.
   • /purchase/{purchase_id}/payment: Manage payments made for specific purchases.
8. Account Endpoint (/account)some text
   • /account/{account_id}/balance: Retrieve the current balance for a specific account.
   • /account/{account_id}/transaction: List transactions associated with a specific account.
9. Item Endpoint (/item)some text
   • /item/{item_id}/inventory: Manage inventory levels for a specific item.
   • /item/{item_id}/sales: Track sales associated with a particular item.
10. Journal Entry Endpoint (/journalentry)some text
    • /journalentry/{journalentry_id}/line: Manage individual line items within a journal entry.
    • /journalentry/{journalentry_id}/reversal: Reverse a journal entry if needed.
11. Employee Endpoint (/employee)some text
    • /employee/{employee_id}/payroll: Manage payroll details and history for a specific employee.
    • /employee/{employee_id}/timeactivity: Retrieve time activities logged by a particular employee.
12. Time Activity Endpoint (/timeactivity)some text
    • /timeactivity/{timeactivity_id}/approve: Approve time entries submitted by employees or contractors.
    • /timeactivity/{timeactivity_id}/project: Associate time activities with specific projects or jobs.
13. Company Info Endpoint (/companyinfo)some text
    • /companyinfo/preferences: Retrieve or update company-level preferences, such as tax settings or currency.
    • /companyinfo/financialyear: Get details about the company's financial year, including start and end dates.

These endpoints offer more granular control and functionality, allowing developers to build more customized and detailed integrations with QuickBooks.

Here’s a detailed reference to all the QuickBooks Online APIs.

‍

QuickBooks Online APIs FAQs

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

1. How to integrate QuickBooks into a PHP codebase? Answer
2. Tracking Shopify Refunds as Payments in QuickBooks Online Answer
3. How to add custom tax to invoice? Answer
4. Is it possible to use intuit quickbooks online API without creating an app Answer
5. How do I link payments to invoices using the API Explorer? Answer

‍

Get started with QuickBooks Online API

‍

QuickBooks Online API access is available only for enterprise and developer tier accounts. If you're looking to integrate with various HRMS or recruitment APIs easily, consider using Knit. Knit offers a single API for connecting with all major HR integrations.

‍

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

‍

Dropbox Sign, formerly HelloSign, is an electronic signature platform allowing users to securely sign, send, and manage legally binding documents online. It can be integrated seamlessly with Dropbox and other cloud services, and simplifies workflows by enabling remote collaboration and reducing the need for physical paperwork. Ideal for businesses of all sizes, Dropbox Sign ensures compliance with global e-signature laws, offering a fast and reliable contract management and document processing solution.

‍

Dropbox Sign APIs enable developers to integrate electronic signature functionality directly into their applications. With easy-to-use endpoints, the API allows businesses to automate document workflows, request signatures, and track the status of agreements in real-time. It supports advanced features like template creation, embedded signing, and customizable branding, making it flexible for many use cases. The API also ensures security and compliance, providing audit trails and adhering to global e-signature standards like ESIGN and eIDAS.

‍

Key highlights of Dropbox Sign APIs include:

• Easy Integration: They simplify embedding e-signatures into websites or apps with minimal code.
• Embedded Signing: They allow users to sign documents directly within your app or site.
• Templates: They support reusable templates for recurring documents, improving workflow efficiency.
• Custom Branding: They also offer white-label options for branded signing experiences.
• Real-time Status Tracking: They provide real-time updates on document signing progress.
• Security & Compliance: They ensure documents meet global e-signature standards (ESIGN, eIDAS) with audit trails and secure encryption.
• Team Management: They support multi-user workflows and team-based access to documents.

In this article, we’ll provide an overview of the Dropbox Sign API endpoints.

‍

Dropbox API Endpoints

Here are the most commonly used Dropbox API endpoints:

Account

• GET /v3/account
• PUT /v3/account
• POST /v3/account/create
• POST /v3/account/verify

Signature Request

• GET /v3/signature_request/{signature_request_id}
• GET /v3/signature_request/list
• GET /v3/signature_request/files/{signature_request_id}
• GET /v3/signature_request/files_as_data_uri/{signature_request_id}
• GET /v3/signature_request/files_as_file_url/{signature_request_id}
• POST /v3/signature_request/send
• POST /v3/signature_request/send_with_template
• POST /v3/signature_request/bulk_send_with_template
• POST /v3/signature_request/remind/{signature_request_id}
• POST /v3/signature_request/release_hold/{signature_request_id}
• POST /v3/signature_request/update/{signature_request_id}
• POST /v3/signature_request/cancel/{signature_request_id}
• POST /v3/signature_request/remove/{signature_request_id}
• POST /v3/signature_request/create_embedded
• POST /v3/signature_request/create_embedded_with_template
• POST /v3/signature_request/bulk_create_embedded_with_template

Templates

• GET /v3/template/{template_id}
• GET /v3/template/list
• POST /v3/template/create
• POST /v3/template/create_embedded_draft
• POST /v3/template/delete/{template_id}
• GET /v3/template/files/{template_id}
• GET /v3/template/files_as_data_uri/{template_id}
• GET /v3/template/files_as_file_url/{template_id}
• POST /v3/template/update_files/{template_id}
• POST /v3/template/add_user/{template_id}
• POST /v3/template/remove_user/{template_id}

Bulk Send Job

• GET /v3/bulk_send_job/{bulk_send_job_id}
• GET /v3/bulk_send_job/list

Report

• POST /v3/report/create

Team

• GET /v3/team
• GET /v3/team/info
• GET /v3/team/members/{team_id}
• GET /v3/team/sub_teams/{team_id}
• POST /v3/team/create
• PUT /v3/team
• DELETE /v3/team/destroy
• PUT /v3/team/add_member
• POST /v3/team/remove_member

Unclaimed Draft

• POST /v3/unclaimed_draft/create
• POST /v3/unclaimed_draft/create_embedded
• POST /v3/unclaimed_draft/create_embedded_with_template
• POST  /v3/unclaimed_draft/edit_and_resend/{signature_request_id}

Embedded

• GET /v3/embedded/sign_url/{signature_id}
• POST /v3/embedded/edit_url/{template_id}

‍

Here’s a detailed reference to all the Dropbox API endpoints.

‍

Dropbox Sign API FAQs

‍

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

‍

1. What is the rate limit for Dropbox sign API? Answer
2. Get Embedded Sign URL is asking for client ID Answer
3. Dropbox sign refresh token getting expired after 1 hour Answer
4. Create Template API Error Answer
5. What is a best way to identify each document with its template after download Answer

‍

Find more FAQs here.

Get started with Dropbox Sign API

‍

Dropbox Sign API access is offered through various pricing plans: Essentials, Standard, and Premium. It also includes a test mode for trying out features before deploying them in production. For quick integration with multiple eSignature APIs, you can use Knit, a single API that connects to top SaaS platforms.

‍

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

‍

PandaDoc is a simple platform for creating, sending, and signing documents like contracts and quotes. It helps businesses reduce paperwork, save time, and work more smoothly with templates and eSignatures.

‍

PandaDoc also provides APIs that let companies integrate its features into their own apps, automating document creation, managing templates, and handling eSignatures easily. This is especially useful for businesses that need to scale or customize their document processes. In this article, we will provide an overview of the Pandadoc API endpoints.

‍

Key features of PandaDoc APIs include:

1. Document Automation: They help to easily create and send documents programmatically, reducing manual tasks.
2. Template Management: They help to access and manage templates directly from your app or system.
3. eSignature Integration: They can be used to seamlessly add legally binding eSignatures to documents.
4. Real-time Tracking: They can be used to monitor document status with real-time notifications and updates.
5. Customizable Workflows: They help to tailor document workflows to fit your business needs.
6. CRM Integration: They can help you connect with popular tools like Salesforce, HubSpot, and others for smooth data flow.
7. Webhooks: They can also be used to get event notifications for document updates, status changes, and more.

These features allow businesses to automate and streamline their document processes effectively.

‍

Pandadoc API Endpoints

Here are the most commonly used Pandadoc API endpoints -

Documents

• GET https://api.pandadoc.com/public/v1/documents
• POST https://api.pandadoc.com/public/v1/documents
• GET https://api.pandadoc.com/public/v1/documents/{id}
• DELETE https://api.pandadoc.com/public/v1/documents/{id}
• POST https://api.pandadoc.com/public/v1/documents/{id}/send
• POST https://api.pandadoc.com/public/v1/documents/{id}/transfer-ownership
• POST https://api.pandadoc.com/public/v1/documents/{id}/attachments

Templates

• GET https://api.pandadoc.com/public/v1/templates
• GET https://api.pandadoc.com/public/v1/templates/{id}
• POST https://api.pandadoc.com/public/v1/templates
• DELETE https://api.pandadoc.com/public/v1/templates/{id}

Folders

• GET https://api.pandadoc.com/public/v1/folders
• POST https://api.pandadoc.com/public/v1/folders
• GET https://api.pandadoc.com/public/v1/folders/{id}
• PATCH https://api.pandadoc.com/public/v1/folders/{id}

Webhooks

• POST https://api.pandadoc.com/public/v1/webhooks
• DELETE https://api.pandadoc.com/public/v1/webhooks/{id}

Contacts

• GET https://api.pandadoc.com/public/v1/contacts
• POST https://api.pandadoc.com/public/v1/contacts
• GET https://api.pandadoc.com/public/v1/contacts/{id}
• PATCH https://api.pandadoc.com/public/v1/contacts/{id}
• DELETE https://api.pandadoc.com/public/v1/contacts/{id}

Users

• GET https://api.pandadoc.com/public/v1/users
• GET https://api.pandadoc.com/public/v1/users/{id}

Here’s a detailed reference to all the Pandadoc APIs.

‍

Pandadoc API FAQs

‍

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

‍

1. What is the limit of PandaDoc? Answer
2. How to getthe API key in PandaDoc? Answer
3. How many documents can I send with PandaDoc? Answer
4. Is PandaDoc legally binding? Answer
5. Can you send multiple documents in PandaDoc? Answer

‍

Find more FAQs here.

‍

Get started with Pandadoc API

‍

Pandadoc API is available for free testing in a sandbox environment and later has to be upgraded to an enterprise account for use in production. However, if you want to integrate with multiple e-signature APIs quickly, you can get started with Knit, one API for all top integrations.

‍

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

‍

‍

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

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

Workday API endpoints

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

Absence management

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

Compensation

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

Payroll

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

Performance management

• GET /feedbackBadges/{ID}

Recruitment

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

Time tracking

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

Talent management

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

‍

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

Workday API use cases

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

Workday API FAQs

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

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

Get started with Workday API

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

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

‍

ADP API

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

‍

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

Related: ADP API Integration (In-Depth) Guide

ADP API Authentication

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

ADP API Events and Endpoints

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

Workers

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

‍

Worker Images

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

‍

Worker Profile Photo Management

• GET/events/hr/v1/worker.photo.remove/meta
• POST/events/hr/v1/worker.photo.remove
• POST/events/hr/v1/worker.photo.upload
• GET/events/hr/v1/worker.photo.upload/meta

‍

Workers Data Retrieval

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

Workers - Lifecycle Management

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

‍

Rehire Worker

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

Workers - Data Integration Management

Read Worker

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

Worker Demographics

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

‍

Worker Demographics

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

Worker Associate Profile - Personal & Work Info

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

‍

Associate Preferred Gender Pronoun

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

Workers - Compensation Management

Add Additional Remuneration

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

‍

Change Additional Remuneration

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

‍

Change Base Remuneration

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

‍

Remove Additional Remuneration

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

Workers - Work Assignment Management

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

‍

Modify Assigned Organizational Units

• POST/events/hr/v1/worker.work-assignment.assigned-organizational-units.modify

‍

Modify Work Assignment

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

‍

Modify Worker Reports 

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

‍

Terminate Work Assignment

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

Personal Contacts

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

‍

Add Personal Contact

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

‍

Change Personal Contact

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

‍

Personal Contacts

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

‍

Remove Personal Contact

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