> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HR Cloud

> How to set up the HR Cloud connector, plus the actions that are available.

![HR Cloud](https://stackone-logos.com/api/hrcloud/filled/svg)

Previewv2.0.1[See changelog](https://docs.stackone.com/connectors/hrcloud/changelog.md)

[64 actions](#actions) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/hrcloud/guides/connector-profile/api-key.md)
>
> Uses the access of an HR Cloud service account, which follows the tenant role granted to it. Time Off, Workmates and Rec...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/hrcloud/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

Recruit

Time Off

Workmates

service\_account

No scopes found

64 actions

ActionDescriptionRequired scopes

List Employees`hrcloud_list_employees`

List Employees via HR Cloud CoreHR REST API.

`service_account`

Get Employee`hrcloud_get_employee`

Get Employee via HR Cloud CoreHR REST API.

`service_account`

Create Employee`hrcloud_create_employee`

Create Employee via HR Cloud CoreHR REST API.

`service_account`

Create Employee Using Mapping`hrcloud_create_employee_with_mapping`

Create one or more employees, where nested Lookup objects can reference parent entities (Department, Location, Position,...

`service_account`

Update Employee`hrcloud_update_employee`

Update Employee via HR Cloud CoreHR REST API.

`service_account`

Update Employee Using Mapping`hrcloud_update_employee_with_mapping`

Update one or more employees, identifying each by an alternative field (xEmail, xEmployeeNumber, etc.) instead of the pr...

`service_account`

Upsert Employee`hrcloud_upsert_employee`

Update or create one or more Employees via HR Cloud CoreHR REST API. Records with a matching Id are updated; records who...

`service_account`

List Employment Statuses`hrcloud_list_employment_status`

List xEmploymentStatus records. Required for resolving xEmploymentStatusLookup on create/update/upsert\_employee.

`service_account`

List Employment Types`hrcloud_list_employment_types`

List xEmploymentType records. Required for resolving xEmploymentTypeLookup on create/update/upsert\_employee. Note xEmplo...

`service_account`

List Departments`hrcloud_list_departments`

List Departments via HR Cloud CoreHR REST API.

`service_account`

Get Department`hrcloud_get_department`

Get Department via HR Cloud CoreHR REST API.

`service_account`

Create Department`hrcloud_create_department`

Create Department via HR Cloud CoreHR REST API.

`service_account`

Update Department`hrcloud_update_department`

Update Department via HR Cloud CoreHR REST API.

`service_account`

Upsert Department`hrcloud_upsert_department`

Update or create a Department via HR Cloud CoreHR REST API. If a record matching the Id (or Identifier query field) exis...

`service_account`

List Divisions`hrcloud_list_divisions`

List Divisions via HR Cloud CoreHR REST API.

`service_account`

Get Division`hrcloud_get_division`

Get Division via HR Cloud CoreHR REST API.

`service_account`

Create Division`hrcloud_create_division`

Create Division via HR Cloud CoreHR REST API.

`service_account`

Update Division`hrcloud_update_division`

Update Division via HR Cloud CoreHR REST API.

`service_account`

Upsert Division`hrcloud_upsert_division`

Update or create a Division via HR Cloud CoreHR REST API. If a record matching the Id (or Identifier query field) exists...

`service_account`

List Locations`hrcloud_list_locations`

List Locations via HR Cloud CoreHR REST API.

`service_account`

Get Location`hrcloud_get_location`

Get Location via HR Cloud CoreHR REST API.

`service_account`

Create Location`hrcloud_create_location`

Create Location via HR Cloud CoreHR REST API.

`service_account`

Update Location`hrcloud_update_location`

Update Location via HR Cloud CoreHR REST API.

`service_account`

Upsert Location`hrcloud_upsert_location`

Update or create a Location via HR Cloud CoreHR REST API. If a record matching the Id (or Identifier query field) exists...

`service_account`

List Positions`hrcloud_list_positions`

List Positions via HR Cloud CoreHR REST API.

`service_account`

Get Position`hrcloud_get_position`

Get Position via HR Cloud CoreHR REST API.

`service_account`

Create Position`hrcloud_create_position`

Create Position via HR Cloud CoreHR REST API.

`service_account`

Update Position`hrcloud_update_position`

Update Position via HR Cloud CoreHR REST API.

`service_account`

Upsert Position`hrcloud_upsert_position`

Update or create a Position via HR Cloud CoreHR REST API. If a record matching the Id (or Identifier query field) exists...

`service_account`

List Position History`hrcloud_list_position_history`

List Position History via HR Cloud CoreHR REST API.

`service_account`

List Applicants`hrcloud_list_applicants`

List Applicants via HR Cloud CoreHR REST API.

`service_account``Recruit`

Get Applicant`hrcloud_get_applicant`

Get a single Applicant by Id. Provider-quirk — when the Id is not found the API returns HTTP 200 with data null instead...

`service_account``Recruit`

Create Applicant`hrcloud_create_applicant`

Create Applicant via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Recruit app to be installed on the tenant (cu...

`service_account``Recruit`

Upload Applicant Resource (Resume / Cover Letter)`hrcloud_upload_applicant_resume`

Upload a resource file (resume, cover letter) to HR Cloud. The endpoint returns a resourceId that is then attached to an...

`service_account``Recruit`

Update Applicant`hrcloud_update_applicant`

Update Applicant via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Recruit app to be installed on the tenant (cu...

`service_account``Recruit`

Upsert Applicant`hrcloud_upsert_applicant`

Update or create an Applicant via HR Cloud CoreHR REST API. If the Id is found the record is updated, otherwise a new ap...

`service_account``Recruit`

List Applicant Statuses`hrcloud_list_applicant_status`

List xApplicantStatus records. Required for resolving xApplicantStatusLookup on create/update/upsert\_applicant.

`service_account``Recruit`

List Tasks`hrcloud_list_tasks`

List Tasks via HR Cloud CoreHR REST API.

`service_account`

Get Task`hrcloud_get_task`

Get Task via HR Cloud CoreHR REST API.

`service_account`

Create Task`hrcloud_create_task`

Create a workflow task in the HR Cloud Portal, assigned to a group of employees, optionally tied to a specific HR applic...

`service_account`

List Employee Groups`hrcloud_list_employee_groups`

List xEmployeeGroup records. Required for resolving `assignedEmployeeGroupId` on create\_task.

`service_account`

Get Employee Group`hrcloud_get_employee_group`

Get a single xEmployeeGroup by Id.

`service_account`

List Bonus History`hrcloud_list_bonus_history`

List Bonus History via HR Cloud CoreHR REST API.

`service_account`

Get Bonus History`hrcloud_get_bonus_history`

Get Bonus History via HR Cloud CoreHR REST API.

`service_account`

List Salary History`hrcloud_list_salary_history`

List Salary History via HR Cloud CoreHR REST API.

`service_account`

List Rehire History`hrcloud_list_rehire_history`

List Rehire History via HR Cloud CoreHR REST API.

`service_account`

Create Rehire History`hrcloud_create_rehire_history`

Start the rehire workflow for a previously terminated employee, restoring their department, location and position. Only...

`service_account`

List Employment Status History`hrcloud_list_employment_status_history`

List Employment Status History via HR Cloud CoreHR REST API.

`service_account`

Create Employment Status History`hrcloud_create_employment_status_history`

Schedule an employment status change for an employee. HR Cloud allows one outstanding change per employee, so the reques...

`service_account`

List Time Off Requests`hrcloud_list_time_off_requests`

List Time Off Requests via HR Cloud CoreHR REST API.

`service_account``Time Off`

Get Time Off Request`hrcloud_get_time_off_request`

Get Time Off Request via HR Cloud CoreHR REST API.

`service_account`

Create Time Off Request`hrcloud_create_time_off_request`

Create Time Off Request via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Time Off app to be installed on the te...

`service_account``Time Off`

Upsert Time Off Request`hrcloud_upsert_time_off_request`

Update or create a Time Off Request via HR Cloud CoreHR REST API. If a Time Off Request with the supplied Id exists it i...

`service_account``Time Off`

List Time Off Accruals`hrcloud_list_time_off_accrual`

List Time Off Accrual History records via HR Cloud CoreHR REST API. Each record represents an adjustment (positive or ne...

`service_account``Time Off`

List Time Off Balances`hrcloud_list_time_off_balance`

List employee Time Off Balances via HR Cloud CoreHR REST API. Balances are read-only computed roll-ups of an employee's...

`service_account``Time Off`

List Time Off Types`hrcloud_list_time_off_types`

List xTimeOffType records. Required for resolving xTimeOffTypeLookup on create\_time\_off\_request and upsert\_time\_off\_requ...

`service_account`

List Employee Attachments`hrcloud_list_employee_attachments`

List Employee Attachments via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Workmates app to be installed on the...

`service_account``Workmates`

Get Employee Attachment`hrcloud_get_employee_attachment`

Get Employee Attachment via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Workmates app to be installed on the t...

`service_account``Workmates`

Create Employee Attachment`hrcloud_create_employee_attachment`

Upload an attachment file to an employee. Content-Type is multipart/form-data per HR Cloud docs. NOTE: REQUIRES the HR C...

`service_account``Workmates`

Delete Employee Attachment`hrcloud_delete_employee_attachment`

Delete Employee Attachment via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Workmates app to be installed on th...

`service_account``Workmates`

Download Employee Attachment(s)`hrcloud_download_employee_attachment`

Download one or more attachments belonging to an employee. Omit attachmentIds to download ALL attachments as a single zi...

`service_account``Workmates`

List Employee Forms`hrcloud_list_employee_forms`

List Employee Forms via HR Cloud CoreHR REST API.

`service_account`

Get Employee Form`hrcloud_get_employee_form`

Retrieve a single form record for an employee, identified by formType + formId.

`service_account`

Download Employee Form`hrcloud_download_employee_form`

Download one or all forms for an employee as a zip file. Pass formIdentifier (formType\_formId) to download a single form...

`service_account`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.