> ## 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.

# Folks HR

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

![Folks HR](https://stackone-logos.com/api/folks-hr/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/folks/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] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/folks/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> 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](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] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/folks/guides/link-account/oauth-2-0-client-credentials.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

64 actions

ActionDescription

List Absence Reasons`folks_list_absence_reasons`

Get a list of absences reasons.

List Absences`folks_list_absences`

Get all absences

Get Absence`folks_get_absence`

Show a specific absence

Create Absence`folks_create_absence`

Add a new absence entry

Update Absence`folks_update_absence`

Update an Absence

Delete Absence`folks_delete_absence`

Delete a specific absence

Get Balance`folks_get_balance`

Get the balance for a given employee and module

List Custom Fields`folks_list_custom_fields`

Get all custom fields

Create Custom Field`folks_create_custom_field`

Create a custom field

Update Custom Field`folks_update_custom_field`

Update a custom field

List Departments`folks_list_departments`

Get all departments

Get Department`folks_get_department`

Get a departments with an Id

Create Department`folks_create_department`

Add a new department

Update Department`folks_update_department`

Update an Department

Delete Department`folks_delete_department`

Delete a department

List All Entity Documents`folks_list_all_entity_documents`

Get a zip of all EDM document

List Documents`folks_list_documents`

Get a paginated list of EDM documents of a given content object

Get Document Content`folks_get_document_content`

Download document

Create Document`folks_create_document`

Store a new EDM Document.

Update Document`folks_update_document`

Update an EDM Document.

Check Duplicate Document`folks_check_duplicate_document`

Duplicate check

Preview Document`folks_preview_document`

Preview document

Delete Document`folks_delete_document`

Delete an EDM Document.

List Folders`folks_list_folders`

Get a list of EDM folders of a given entity

Create Folder`folks_create_folder`

Store a new EDM Folder.

Update Folder`folks_update_folder`

Update an EDM Folder.

Delete Folder`folks_delete_folder`

Delete an EDM Folder.

Set Employee Custom Field Value`folks_set_employee_custom_field_value`

Create or update the value of the specified custom field for an employee.

Update Employee Custom Field Value`folks_update_employee_custom_field_value`

Update the value of the specified custom field for an employee.

Delete Employee Custom Field Value`folks_delete_employee_custom_field_value`

Delete the value of the specified custom field for an employee.

List Employee Profile Notes`folks_list_employee_profile_notes`

List employee profile notes

Create Employee Profile Note`folks_create_employee_profile_note`

Create a new employee profile note. Requires the \<employees:write> scope.

Update Employee Profile Note`folks_update_employee_profile_note`

Update an existing employee profile note. Requires the \<employees:write> scope.

Delete Employee Profile Note`folks_delete_employee_profile_note`

Delete an employee profile note. Requires the \<employees:destroy> scope.

List Employees`folks_list_employees`

List the employees of the company.

Get Employee`folks_get_employee`

Show a specific employee

Create Employee`folks_create_employee`

Add a new employee

Upload Employee Image`folks_upload_employee_image`

Add a new employee image and delete the old one if it exists.

Update Employee`folks_update_employee`

Update an Employee

Delete Employee`folks_delete_employee`

Delete an employee

Delete Employee Image`folks_delete_employee_image`

Delete an employee image

List Overtime Multipliers`folks_list_overtime_multipliers`

Gets the possible multipliers

List Overtime Types`folks_list_overtime_types`

Get a list of overtime types

List Overtimes`folks_list_overtimes`

Get all overtimes

Get Overtime`folks_get_overtime`

Show a specific overtime

Create Overtime`folks_create_overtime`

Add a new overtime entry

Update Overtime`folks_update_overtime`

Update an Overtime

Delete Overtime`folks_delete_overtime`

Delete a specific overtime

List Positions`folks_list_positions`

Get all positions

Get Position`folks_get_position`

Get a position with an Id

Create Position`folks_create_position`

Add a new position

Update Position`folks_update_position`

Update a existing position

Delete Position`folks_delete_position`

Delete a specific position

List Vacation Types`folks_list_vacation_types`

Get a list of vacation types

List Vacations`folks_list_vacations`

Get all vacations

Get Vacation`folks_get_vacation`

Get a specific vacation

Create Vacation`folks_create_vacation`

Add a new vacation entry

Update Vacation`folks_update_vacation`

Update a specific vacation

Delete Vacation`folks_delete_vacation`

Delete a specific vacation

List Working Sites`folks_list_working_sites`

Get all working-sites

Get Working Site`folks_get_working_site`

Get a working-site with an Id

Create Working Site`folks_create_working_site`

Add a new working site

Update Working Site`folks_update_working_site`

Update a Working Site

Delete Working Site`folks_delete_working_site`

Delete a working site


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