--- title: "HR Cloud API Directory" description: "Learn about the common HR Cloud API data models and API end points in this comprehensive HR Cloud API directory" source_url: "https://www.getknit.dev/blog/hr-cloud-api-directory-YsAWFD" page_type: "blog" --- _This is an educational blog post from Knit's blog: “HR Cloud API Directory”._ # HR Cloud API Directory HR Cloud software is a comprehensive digital platform hosted on the cloud, designed to streamline and enhance human resources functions. It offers a suite of tools and services that assist organizations in managing critical HR tasks such as employee data management, recruitment, onboarding, payroll, and benefits administration. By leveraging HR Cloud software, companies can efficiently handle performance management, time and attendance tracking, learning and development, and compliance reporting. This software is indispensable for HR professionals, managers, and employees across various industries, aiming to optimize workforce management and boost organizational efficiency. HR Cloud offers a suite of RESTful APIs that enable developers to programmatically access and manage various HR-related data and services within the HR Cloud platform. These APIs facilitate seamless integration with external applications, allowing for operations such as retrieving employee information, managing departments, and handling documents. **Key Features of HR Cloud APIs:** * **RESTful Architecture:** The APIs adhere to REST principles, utilizing standard HTTP methods (GET, POST, PUT, DELETE) for resource manipulation. This design ensures compatibility and ease of integration with various systems. [HRCloud Help](https://help.hrcloud.com/api/) * **JSON Payloads:** Data is exchanged in JSON format, providing a lightweight and easily parsable structure for client applications. [HRCloud Help](https://help.hrcloud.com/api/) * **Versioning Support:** The APIs support versioning, allowing organizations to adopt new features at their own pace without disrupting existing integrations. [HRCloud Help](https://help.hrcloud.com/api/) **Core HR API:** The Core HR API provides programmatic access to common HR activities, including: * **Employee Management:** Retrieve and update employee information, including attachments and forms. * **Department and Division Management:** Access and modify details of departments and divisions. * **Location Management:** Manage location data pertinent to the organization. * **Task Management:** Create and manage tasks assigned to employees. Detailed documentation for the Core HR API is available, outlining endpoints, request structures, and response formats. [HRCloud Help](https://help.hrcloud.com/api/) **Employee API:** The Employee API focuses on operations related to employee data, such as: * **Retrieving Employee Details:** Fetch comprehensive information about employees, including personal and employment-related data. * **Creating and Updating Employees:** Programmatically add new employees or update existing employee records. Comprehensive details and usage examples for the Employee API can be found in the official documentation. [HR Cloud Support](https://support.hrcloud.com/en/help-center/employeeapi) **Authentication and Authorization:** HR Cloud APIs implement robust authentication and authorization mechanisms to ensure secure access. Developers must obtain appropriate credentials and tokens to interact with the APIs, adhering to the security protocols outlined in the documentation. [HR Cloud Support](https://support.hrcloud.com/en/help-center/hr-cloud-api) **Integration with External Systems:** HR Cloud's APIs facilitate integration with various external systems, such as Microsoft Power Automate, enabling organizations to automate workflows and synchronize HR data across platforms. [Microsoft Learn](https://learn.microsoft.com/en-us/connectors/hrcloud/) ### **Applicant APIs** * POST /xApplicant : Create an Applicant * post /xApplicant/Resource : Post XApplicant Resource * GET https://corehr-api.hrcloud.com/v1/cloud/xApplicant : Retrieve Applicants * GET https://corehr-api.hrcloud.com/v1/cloud/xApplicant/:applicantId : Retrieve Single Applicant * PUT https://corehr-api.hrcloud.com/v1/cloud/xApplicant/Upsert : Upsert Applicant ### **Bonus History APIs** * GET https://corehr-api.hrcloud.com/v1/cloud/xBonusHistory : Retrieve Bonus History * GET https://corehr-api.hrcloud.com/v1/cloud/xBonusHistory/:bonusid : Get One Bonus ### **Department APIs** * GET https://corehr-api.hrcloud.com/v1/cloud/xDepartment : GET departments * GET https://corehr-api.hrcloud.com/v1/cloud/xDepartment/:departmentId : GET single department * PUT https://corehr-api.hrcloud.com/v1/cloud/xDepartment/Upsert : Update or Create a Department ### **Division APIs** * GET https://corehr-api.hrcloud.com/v1/cloud/xDivision : GET divisions * PUT https://corehr-api.hrcloud.com/v1/cloud/xDivision/Upsert : PUT division upsert ### **Employee APIs** * POST https://corehr-api.hrcloud.com/v1/cloud/xEmployee : Create Employee with Mapping Parameters * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId : GET single employee * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments : Retrieve Employee Attachments * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/:attachmentId : Get one attachment of an employee * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/download : GET employee attachment download all * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/download/:attachmentId : Download Employee Attachment * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/download/:attachmentId1,:attachmentId2,... : GET employee attachment download multiple * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/form/:formType/:formId : Get one form of an employee * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/forms : Retrieve Employee Forms * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/forms/download : Download All Employee Forms * GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/forms/download/:formType1\_formId1,:formType2\_formId2 : GET employee forms download single or multiple * PUT https://corehr-api.hrcloud.com/v1/cloud/xEmployee/Picture : PUT employee picture * POST https://corehr-api.hrcloud.com/v1/cloud/xEmployee/Resource/Picture : Upload Employee Picture * PUT https://corehr-api.hrcloud.com/v1/cloud/xEmployee/Upsert : PUT employee param upsert ### **Employment Status History APIs** * POST https://corehr-api.hrcloud.com/v1/cloud/xEmploymentStatusHistory : Create Employment Status History * GET https://corehr-api.hrcloud.com/v1/cloud/xEmploymentStatusHistory/:employmentid : Get Employment Status Change Details ### **Location APIs** * PUT https://corehr-api.hrcloud.com/v1/cloud/xLocation : Update Location * GET https://corehr-api.hrcloud.com/v1/cloud/xLocation/:locationId : GET single division * PUT https://corehr-api.hrcloud.com/v1/cloud/xLocation/Upsert : PUT location ### **Position APIs** * POST https://corehr-api.hrcloud.com/v1/cloud/xPosition : Create a Position * GET https://corehr-api.hrcloud.com/v1/cloud/xPosition/:positionId : GET single position * PUT https://corehr-api.hrcloud.com/v1/cloud/xPosition/Upsert : PUT position upsert ### **Position History APIs** * GET https://corehr-api.hrcloud.com/v1/cloud/xPositionHistory : GET position history * GET https://corehr-api.hrcloud.com/v1/cloud/xPositionHistory/:positionid : GET one position history ### **Rehire History APIs** * GET https://corehr-api.hrcloud.com/v1/cloud/xRehireHistory : Retrieve Rehire History * GET https://corehr-api.hrcloud.com/v1/cloud/xRehireHistory/:rehireid : Get One Rehire ### **Salary History APIs** * GET https://corehr-api.hrcloud.com/v1/cloud/xSalaryHistory : Retrieve Salary History * GET https://corehr-api.hrcloud.com/v1/cloud/xSalaryHistory/:salaryid : Get One Salary ### **Task APIs** * GET https://corehr-api.hrcloud.com/v1/cloud/xTask : Retrieve a list of tasks * GET https://corehr-api.hrcloud.com/v1/cloud/xTask/:taskId : GET single task * POST https://corehr-api.hrcloud.com/v1/cloud/xTask/Portal : Create a Plain Task ## Get Started with HR Cloud API Integration * **Access Documentation:** Review the comprehensive API documentation to understand available endpoints and their functionalities. [HRCloud Help](https://help.hrcloud.com/api/) * **Obtain Credentials:** Register your application and acquire the necessary authentication credentials as per the guidelines provided. [HR Cloud Support](https://support.hrcloud.com/en/help-center/hr-cloud-api) * **Implement API Calls:** Utilize standard HTTP methods to interact with the APIs, ensuring adherence to the request and response formats specified in the documentation. ## About Knit Knit API offers a convenient solution for quick and seamless integration with HR Cloud API. Our AI-powered integration platform allows you to build [any HR Cloud API Integration use case](https://developers.getknit.dev/docs/hrcloud-usecases). By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to HR Cloud API. To sign up for free, [click here](https://app.getknit.dev/signup). To check the pricing, see our [pricing page](https://www.getknit.dev/pricing). ## Related pages - [How Knit works](https://md.getknit.dev/how-knit-works) - [Unified API product](https://md.getknit.dev/products/unified-api)