Skip to main content
HR Cloud
HR Cloud
64 actions · 1 auth method
PreviewHRIS

​
Authentication

API Key

HR Cloud authenticates each request with two custom HTTP headers — Customer_Key and Customer_Secret — both minted in the…Guides: Connector Profile, Link Account
Actions
|
64 actions
Action
Description
Required scopes
List Employees
List Employees via HR Cloud CoreHR REST API.
Get Employee
Get Employee via HR Cloud CoreHR REST API.
Create Employee
Create Employee via HR Cloud CoreHR REST API.
Create Employee Using Mapping
Create one or more employees, where nested Lookup objects can reference parent entities (Department, Location, Position,…
Update Employee
Update Employee via HR Cloud CoreHR REST API.
Update Employee Using Mapping
Update one or more employees, identifying each by an alternative field (xEmail, xEmployeeNumber, etc.) instead of the pr…
Upsert Employee
Update or create one or more Employees via HR Cloud CoreHR REST API. Records with a matching Id are updated; records who…
List Employment Statuses
List xEmploymentStatus records. Required for resolving xEmploymentStatusLookup on create/update/upsert_employee.
List Employment Types
List xEmploymentType records. Required for resolving xEmploymentTypeLookup on create/update/upsert_employee. Note xEmplo…
List Departments
List Departments via HR Cloud CoreHR REST API.
Get Department
Get Department via HR Cloud CoreHR REST API.
Create Department
Create Department via HR Cloud CoreHR REST API.
Update Department
Update Department via HR Cloud CoreHR REST API.
Upsert Department
Update or create a Department via HR Cloud CoreHR REST API. If a record matching the Id (or Identifier query field) exis…
List Divisions
List Divisions via HR Cloud CoreHR REST API.
Get Division
Get Division via HR Cloud CoreHR REST API.
Create Division
Create Division via HR Cloud CoreHR REST API.
Update Division
Update Division via HR Cloud CoreHR REST API.
Upsert Division
Update or create a Division via HR Cloud CoreHR REST API. If a record matching the Id (or Identifier query field) exists…
List Locations
List Locations via HR Cloud CoreHR REST API.
Get Location
Get Location via HR Cloud CoreHR REST API.
Create Location
Create Location via HR Cloud CoreHR REST API.
Update Location
Update Location via HR Cloud CoreHR REST API.
Upsert Location
Update or create a Location via HR Cloud CoreHR REST API. If a record matching the Id (or Identifier query field) exists…
List Positions
List Positions via HR Cloud CoreHR REST API.
Get Position
Get Position via HR Cloud CoreHR REST API.
Create Position
Create Position via HR Cloud CoreHR REST API.
Update Position
Update Position via HR Cloud CoreHR REST API.
Upsert Position
Update or create a Position via HR Cloud CoreHR REST API. If a record matching the Id (or Identifier query field) exists…
List Position History
List Position History via HR Cloud CoreHR REST API.
List Applicants
List Applicants via HR Cloud CoreHR REST API.
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…
Create Applicant
Create Applicant via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Recruit app to be installed on the tenant (cu…
Upload Applicant Resource (Resume / Cover Letter)
Upload a resource file (resume, cover letter) to HR Cloud. The endpoint returns a resourceId that is then attached to an…
Update Applicant
Update Applicant via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Recruit app to be installed on the tenant (cu…
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…
List Applicant Statuses
List xApplicantStatus records. Required for resolving xApplicantStatusLookup on create/update/upsert_applicant.
List Tasks
List Tasks via HR Cloud CoreHR REST API.
Get Task
Get Task via HR Cloud CoreHR REST API.
Create Task
Create a workflow task in the HR Cloud Portal, assigned to a group of employees, optionally tied to a specific HR applic…
List Employee Groups
List xEmployeeGroup records. Required for resolving assignedEmployeeGroupId on create_task.
Get Employee Group
Get a single xEmployeeGroup by Id.
List Bonus History
List Bonus History via HR Cloud CoreHR REST API.
Get Bonus History
Get Bonus History via HR Cloud CoreHR REST API.
List Salary History
List Salary History via HR Cloud CoreHR REST API.
List Rehire History
List Rehire History via HR Cloud CoreHR REST API.
Create Rehire History
Create a rehire history record (initiate a rehire workflow for an employee). NOTE; provider returns 400 “This action is…
List Employment Status History
List Employment Status History via HR Cloud CoreHR REST API.
Create Employment Status History
Create a new employment status history entry (changes an employee’s employment status). NOTE; provider returns 400 “Ther…
List Time Off Requests
List Time Off Requests via HR Cloud CoreHR REST API.
Get Time Off Request
Get Time Off Request via HR Cloud CoreHR REST API.
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…
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…
List Time Off Accruals
List Time Off Accrual History records via HR Cloud CoreHR REST API. Each record represents an adjustment (positive or ne…
List Time Off Balances
List employee Time Off Balances via HR Cloud CoreHR REST API. Balances are read-only computed roll-ups of an employee’s…
List Time Off Types
List xTimeOffType records. Required for resolving xTimeOffTypeLookup on create_time_off_request and upsert_time_off_requ…
List Employee Attachments
List Employee Attachments via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Workmates app to be installed on the…
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…
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…
Delete Employee Attachment
Delete Employee Attachment via HR Cloud CoreHR REST API. NOTE: REQUIRES the HR Cloud Workmates app to be installed on th…
Download Employee Attachment(s)
Download one or more attachments belonging to an employee. Omit attachmentIds to download ALL attachments as a single zi…
List Employee Forms
List Employee Forms via HR Cloud CoreHR REST API.
Get Employee Form
Retrieve a single form record for an employee, identified by formType + formId.
Download Employee Form
Download one or all forms for an employee as a zip file. Pass formIdentifier (formType_formId) to download a single form…

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/hrcloud/filled/png

Connector Profile

HR Cloud - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/hrcloud/filled/png

Link Account

HR Cloud - API Key
4

Use Actions

Invoke actions using one of the methods below: