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

# Factorial

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

![Factorial](https://stackone-logos.com/api/factorial/filled/svg)

Previewv1.1.0[See changelog](https://docs.stackone.com/connectors/factorialhr/changelog.md)

[127 actions](#actions) · 2 auth methods

HRIS
ATS

## 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/factorialhr/guides/connector-profile/api-key.md)

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/factorialhr/guides/connector-profile/oauth-2-0.md)
>
> The steps in this guide require Admin privileges in your Factorial account.

**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/factorialhr/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/factorialhr/guides/link-account/oauth-2-0.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

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

company\_holidays

company\_legal\_entities

company\_locations

contracts

custom\_fields

employee\_updates

employees

recruitment

time\_off

No scopes found

127 actions

ActionDescriptionRequired scopes

Get Credentials`factorialhr_get_credentials`

Retrieve information about the current API token owner.

List Answers`factorialhr_list_answers`

Retrieve a list of all answers to job application questions

`recruitment`

Create Answer`factorialhr_create_answer`

Create a new answer to an application question

`recruitment`

Get Answer`factorialhr_get_answer`

Retrieve detailed information for a specific answer

`recruitment`

List Application Phases`factorialhr_list_application_phases`

Retrieve a list of all application phases in the hiring pipeline.

`recruitment`

Get Application Phase`factorialhr_get_application_phase`

Retrieve detailed information for a specific application phase

`recruitment`

List Applications`factorialhr_list_applications`

Retrieve a list of all job applications

`recruitment`

Create Application`factorialhr_create_application`

Create a new job application

`recruitment`

Get Application`factorialhr_get_application`

Retrieve detailed information for a specific application

`recruitment`

Update Application`factorialhr_update_application`

Update an existing job application

`recruitment`

Delete Application`factorialhr_delete_application`

Delete a specific job application

`recruitment`

Apply To Job`factorialhr_apply_to_job`

Submit a job application as a candidate

`recruitment`

List Candidate Sources`factorialhr_list_candidate_sources`

Retrieve a list of all candidate sources.

`recruitment`

Get Candidate Source`factorialhr_get_candidate_source`

Retrieve detailed information for a specific candidate source

`recruitment`

List Candidates`factorialhr_list_candidates`

Retrieve a list of all candidates.

`recruitment`

Create Candidate`factorialhr_create_candidate`

Create a new candidate in the ATS

`recruitment`

Get Candidate`factorialhr_get_candidate`

Retrieve detailed information for a specific candidate

`recruitment`

Update Candidate`factorialhr_update_candidate`

Update an existing candidate

`recruitment`

Delete Candidate`factorialhr_delete_candidate`

Delete a specific candidate

`recruitment`

List Hiring Stages`factorialhr_list_hiring_stages`

Retrieve a list of all hiring stages

`recruitment`

Get Hiring Stage`factorialhr_get_hiring_stage`

Retrieve detailed information for a specific hiring stage

`recruitment`

List Job Postings`factorialhr_list_job_postings`

Retrieve a list of all job postings

`recruitment`

Create Job Posting`factorialhr_create_job_posting`

Create a new job posting

`recruitment`

Get Job Posting`factorialhr_get_job_posting`

Retrieve detailed information for a specific job posting

`recruitment`

Update Job Posting`factorialhr_update_job_posting`

Update an existing job posting

`recruitment`

Delete Job Posting`factorialhr_delete_job_posting`

Delete a specific job posting

`recruitment`

Duplicate Job Posting`factorialhr_duplicate_job_posting`

Duplicate an existing job posting

`recruitment`

List Questions`factorialhr_list_questions`

Retrieve a list of all questions.

`recruitment`

Create Question`factorialhr_create_question`

Create a new question for a job posting

`recruitment`

Get Question`factorialhr_get_question`

Retrieve detailed information for a specific question

`recruitment`

Update Question`factorialhr_update_question`

Update an existing question

`recruitment`

Delete Question`factorialhr_delete_question`

Delete a specific question

`recruitment`

List Rejection Reasons`factorialhr_list_rejection_reasons`

Retrieve a list of all rejection reasons.

`recruitment`

Get Rejection Reason`factorialhr_get_rejection_reason`

Retrieve detailed information for a specific rejection reason

`recruitment`

List Legal Entities`factorialhr_list_legal_entities`

Retrieve a list of all legal entities

`company_legal_entities`

Create Legal Entity`factorialhr_create_legal_entity`

Create a new legal entity

`company_legal_entities`

Get Legal Entity`factorialhr_get_legal_entity`

Retrieve a single legal entity by ID

`company_legal_entities`

List Compensation Concepts`factorialhr_list_compensation_concepts`

Retrieve a list of all compensation concepts

`contracts`

Get Compensation Concept`factorialhr_get_compensation_concept`

Retrieve a single compensation concept by ID

`contracts`

List Custom Fields`factorialhr_list_custom_fields`

Retrieve a list of all custom fields with filtering options

`custom_fields`

Get Custom Field`factorialhr_get_custom_field`

Retrieve detailed information for a specific custom field

`custom_fields`

Create Custom Field`factorialhr_create_custom_field`

Create a new custom field definition

`custom_fields`

Delete Custom Field`factorialhr_delete_custom_field`

Delete a custom field definition

`custom_fields`

List Custom Field Options`factorialhr_list_custom_field_options`

Retrieve all options for custom fields

`custom_fields`

Create Custom Field Option`factorialhr_create_custom_field_option`

Create a new option for a custom field

`custom_fields`

Get Custom Field Option`factorialhr_get_custom_field_option`

Retrieve a specific custom field option by ID

`custom_fields`

List Resource Fields`factorialhr_list_resource_fields`

Retrieve all resource fields for custom schemas

`custom_fields`

Create Resource Field`factorialhr_create_resource_field`

Create a new resource field for a schema

`custom_fields`

Get Resource Field`factorialhr_get_resource_field`

Retrieve a specific resource field by ID

`custom_fields`

List Custom Field Values`factorialhr_list_custom_field_values`

Retrieve all custom field values

`custom_fields`

Create Custom Field Value`factorialhr_create_custom_field_value`

Create a new custom field value

`custom_fields`

Get Custom Field Value`factorialhr_get_custom_field_value`

Retrieve a specific custom field value by ID

`custom_fields`

Update Custom Field Value`factorialhr_update_custom_field_value`

Update an existing custom field value

`custom_fields`

List Custom Resources`factorialhr_list_custom_resources`

Retrieve all custom resources

`custom_fields`

Get Custom Resource`factorialhr_get_custom_resource`

Retrieve a specific custom resource by ID

`custom_fields`

List Custom Resource Schemas`factorialhr_list_custom_resource_schemas`

Retrieve all custom resource schemas

`custom_fields`

Create Custom Resource Schema`factorialhr_create_custom_resource_schema`

Create a new custom resource schema

`custom_fields`

Get Custom Resource Schema`factorialhr_get_custom_resource_schema`

Retrieve a specific custom resource schema by ID

`custom_fields`

List Custom Resource Values`factorialhr_list_custom_resource_values`

Retrieve all custom resource values

`custom_fields`

Create Custom Resource Value`factorialhr_create_custom_resource_value`

Create a new custom resource value

`custom_fields`

Get Custom Resource Value`factorialhr_get_custom_resource_value`

Retrieve a specific custom resource value by ID

`custom_fields`

List Employee Update Absences`factorialhr_list_employee_update_absences`

Retrieve all absence employee updates

`employee_updates`

Get Employee Update Absence`factorialhr_get_employee_update_absence`

Retrieve a specific absence employee update by ID

`employee_updates`

List Employee Update Contract Changes`factorialhr_list_employee_update_contract_changes`

Retrieve all contract change employee updates

`employee_updates`

Get Employee Update Contract Change`factorialhr_get_employee_update_contract_change`

Retrieve a specific contract change employee update by ID

`employee_updates`

List Employee Update New Hires`factorialhr_list_employee_update_new_hires`

Retrieve all new hire employee updates

`employee_updates`

Get Employee Update New Hire`factorialhr_get_employee_update_new_hire`

Retrieve a specific new hire employee update by ID

`employee_updates`

List Employee Update Personal Changes`factorialhr_list_employee_update_personal_changes`

Retrieve all personal change employee updates

`employee_updates`

Get Employee Update Personal Change`factorialhr_get_employee_update_personal_change`

Retrieve a specific personal change employee update by ID

`employee_updates`

List Employee Update Summaries`factorialhr_list_employee_update_summaries`

Retrieve all employee update summaries

`employee_updates`

Get Employee Update Summary`factorialhr_get_employee_update_summary`

Retrieve a specific employee update summary by ID

`employee_updates`

List Employee Update Terminations`factorialhr_list_employee_update_terminations`

Retrieve all termination employee updates

`employee_updates`

Get Employee Update Termination`factorialhr_get_employee_update_termination`

Retrieve a specific termination employee update by ID

`employee_updates`

List Employees`factorialhr_list_employees`

Retrieve a list of all employees

`employees`

Get Employee`factorialhr_get_employee`

Retrieve detailed information for a specific employee

`employees`

Update Employee`factorialhr_update_employee`

Update an existing employee's information

`employees`

Create Employee With Contract`factorialhr_create_employee_with_contract`

Create a new employee with contract details

`employees`

Invite Employee`factorialhr_invite_employee`

Send an email invitation to an unconfirmed employee

`employees`

Set Employee Access Start Date`factorialhr_set_employee_access_start_date`

Set regular access start date for an employee

`employees`

Terminate Employee`factorialhr_terminate_employee`

Terminate an employee

`employees`

Unterminate Employee`factorialhr_unterminate_employee`

Reverse the termination of an employee

`employees`

List Company Holidays`factorialhr_list_company_holidays`

Retrieve all company holidays

`company_holidays`

Get Company Holiday`factorialhr_get_company_holiday`

Retrieve a specific company holiday by ID

`company_holidays`

List Locations`factorialhr_list_locations`

Retrieve a list of all locations

`company_locations`

Get Location`factorialhr_get_location`

Retrieve detailed information for a specific location

`company_locations`

Create Location`factorialhr_create_location`

Create a new location

`company_locations`

Update Location`factorialhr_update_location`

Update an existing location

`company_locations`

Delete Location`factorialhr_delete_location`

Delete a location

`company_locations`

List Work Areas`factorialhr_list_work_areas`

Retrieve a list of all work areas

`company_locations`

Get Work Area`factorialhr_get_work_area`

Retrieve detailed information for a specific work area

`company_locations`

Create Work Area`factorialhr_create_work_area`

Create a new work area

`company_locations`

Update Work Area`factorialhr_update_work_area`

Update an existing work area

`company_locations`

Archive Work Area`factorialhr_archive_work_area`

Archive a work area

`company_locations`

Unarchive Work Area`factorialhr_unarchive_work_area`

Unarchive a work area

`company_locations`

List Team Memberships`factorialhr_list_team_memberships`

Retrieve a list of all team memberships

`employees`

Get Team Membership`factorialhr_get_team_membership`

Retrieve detailed information for a specific team membership

`employees`

Create Team Membership`factorialhr_create_team_membership`

Create a new team membership

`employees`

Update Team Membership`factorialhr_update_team_membership`

Update an existing team membership

`employees`

Delete Team Membership`factorialhr_delete_team_membership`

Delete a team membership

`employees`

List Teams`factorialhr_list_teams`

Retrieve a list of all teams

`employees`

Get Team`factorialhr_get_team`

Retrieve detailed information for a specific team

`employees`

Create Team`factorialhr_create_team`

Create a new team

`employees`

Update Team`factorialhr_update_team`

Update an existing team

`employees`

Delete Team`factorialhr_delete_team`

Delete a team

`employees`

List Leave Types`factorialhr_list_leave_types`

Retrieve all leave types

`time_off`

Create Leave Type`factorialhr_create_leave_type`

Create a new leave type

`time_off`

Get Leave Type`factorialhr_get_leave_type`

Retrieve a specific leave type by ID

`time_off`

Update Leave Type`factorialhr_update_leave_type`

Update an existing leave type

`time_off`

List Leaves`factorialhr_list_leaves`

Retrieve all leave requests

`time_off`

Create Leave`factorialhr_create_leave`

Create a new leave request

`time_off`

Get Leave`factorialhr_get_leave`

Retrieve a specific leave request by ID

`time_off`

Update Leave`factorialhr_update_leave`

Update an existing leave request

`time_off`

Delete Leave`factorialhr_delete_leave`

Delete a leave request

`time_off`

Approve Leave`factorialhr_approve_leave`

Approve a leave request

`time_off`

Approve All Leaves`factorialhr_approve_all_leaves`

Approve multiple leave requests

`time_off`

Reject Leave`factorialhr_reject_leave`

Reject a leave request

`time_off`

List Timeoff Policies`factorialhr_list_timeoff_policies`

Retrieve all timeoff policies

`time_off`

Create Timeoff Policy`factorialhr_create_timeoff_policy`

Create a new timeoff policy

`time_off`

Get Timeoff Policy`factorialhr_get_timeoff_policy`

Retrieve a specific timeoff policy by ID

`time_off`

Update Timeoff Policy`factorialhr_update_timeoff_policy`

Update an existing timeoff policy

`time_off`

Delete Timeoff Policy`factorialhr_delete_timeoff_policy`

Delete a timeoff policy

`time_off`

List Policy Assignments`factorialhr_list_policy_assignments`

Retrieve all policy assignments

`time_off`

Create Policy Assignment`factorialhr_create_policy_assignment`

Create a new policy assignment

`time_off`

Get Policy Assignment`factorialhr_get_policy_assignment`

Retrieve a specific policy assignment by ID

`time_off`

Update Policy Assignment`factorialhr_update_policy_assignment`

Update an existing policy assignment

`time_off`

Delete Policy Assignment`factorialhr_delete_policy_assignment`

Delete a policy assignment

`time_off`

List Policy Timelines`factorialhr_list_policy_timelines`

Retrieve all policy timelines

`time_off`


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