Skip to main content
Folks HR
Betav0.1.0
64 actions · 1 auth method

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0 (Client Credentials)

Folks HR uses an OAuth 2.0 Client Credentials flow. A company administrator generates a “V2” API key (Client ID and Clie…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0 (Client Credentials)

4

Use Actions

Connect your agent to the linked account’s actions. See Agent Setup.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

64 actions
Action
Description
List Absence Reasons
Get a list of absences reasons.
List Absences
Get all absences
Get Absence
Show a specific absence
Create Absence
Add a new absence entry
Update Absence
Update an Absence
Delete Absence
Delete a specific absence
Get Balance
Get the balance for a given employee and module
List Custom Fields
Get all custom fields
Create Custom Field
Create a custom field
Update Custom Field
Update a custom field
List Departments
Get all departments
Get Department
Get a departments with an Id
Create Department
Add a new department
Update Department
Update an Department
Delete Department
Delete a department
List All Entity Documents
Get a zip of all EDM document
List Documents
Get a paginated list of EDM documents of a given content object
Get Document Content
Download document
Create Document
Store a new EDM Document.
Update Document
Update an EDM Document.
Check Duplicate Document
Duplicate check
Preview Document
Preview document
Delete Document
Delete an EDM Document.
List Folders
Get a list of EDM folders of a given entity
Create Folder
Store a new EDM Folder.
Update Folder
Update an EDM Folder.
Delete Folder
Delete an EDM Folder.
Set Employee Custom Field Value
Create or update the value of the specified custom field for an employee.
Update Employee Custom Field Value
Update the value of the specified custom field for an employee.
Delete Employee Custom Field Value
Delete the value of the specified custom field for an employee.
List Employee Profile Notes
List employee profile notes
Create Employee Profile Note
Create a new employee profile note. Requires the <employees:write> scope.
Update Employee Profile Note
Update an existing employee profile note. Requires the <employees:write> scope.
Delete Employee Profile Note
Delete an employee profile note. Requires the <employees:destroy> scope.
List Employees
List the employees of the company.
Get Employee
Show a specific employee
Create Employee
Add a new employee
Upload Employee Image
Add a new employee image and delete the old one if it exists.
Update Employee
Update an Employee
Delete Employee
Delete an employee
Delete Employee Image
Delete an employee image
List Overtime Multipliers
Gets the possible multipliers
List Overtime Types
Get a list of overtime types
List Overtimes
Get all overtimes
Get Overtime
Show a specific overtime
Create Overtime
Add a new overtime entry
Update Overtime
Update an Overtime
Delete Overtime
Delete a specific overtime
List Positions
Get all positions
Get Position
Get a position with an Id
Create Position
Add a new position
Update Position
Update a existing position
Delete Position
Delete a specific position
List Vacation Types
Get a list of vacation types
List Vacations
Get all vacations
Get Vacation
Get a specific vacation
Create Vacation
Add a new vacation entry
Update Vacation
Update a specific vacation
Delete Vacation
Delete a specific vacation
List Working Sites
Get all working-sites
Get Working Site
Get a working-site with an Id
Create Working Site
Add a new working site
Update Working Site
Update a Working Site
Delete Working Site
Delete a working site