> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/factorial.md).

# Factorial

Factorial is an all-in-one HR platform. List and create employees, browse teams, review time-off leaves, and read contract data from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector           | Authentication |
| ------------------- | -------------- |
| Factorial (API Key) | API Key        |

#### Factorial (API Key)

Connect to Factorial to manage employees, teams, time off, and contracts.

**Set up in Factorial**

1. Prepare the Factorial account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Your Factorial API key, generated by an administrator in the Factorial platform (Settings -> API Keys). API keys have full admin access to the company, so store them carefully.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Factorial (API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                                                                               |
| ------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes                      | Your Factorial API key, generated by an administrator in the Factorial platform (Settings -> API Keys). API keys have full admin access to the company, so store them carefully. [Provider instructions](https://help.factorialhr.com/how-to-create-api-keys-in-factorial). |
| Environment   | Optional / as applicable | Factorial environment: 'production' or 'demo'. Credentials are environment-specific; a mismatch yields empty responses.                                                                                                                                                     |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Factorial** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Employees

List employees, with optional email, name, and team filters.

**Inputs**

| Field         | Type            | Required | Description                                                                  |
| ------------- | --------------- | -------- | ---------------------------------------------------------------------------- |
| Emails        | array           | No       | Return only employees with these exact email addresses.                      |
| Name Search   | string          | No       | Free-text search on the employee name.                                       |
| Team          | select (string) | No       | Return only members of this team. Options load from the selected connection. |
| Only Active   | boolean         | No       | Return only active employees (default true).                                 |
| Only Managers | boolean         | No       | Return only employees who manage others (default false).                     |
| Limit         | integer         | No       | Maximum employees to return (default 100).                                   |

**Outputs**

| Field     | Type        | Description                                           |
| --------- | ----------- | ----------------------------------------------------- |
| Employees | dict\_array | The employees matching the filters.                   |
| Total     | integer     | Total employees matching the filters.                 |
| Has More  | boolean     | True if more employees exist beyond the returned set. |

#### Create Employee

Create an employee (with a minimal initial contract) in a company.

**Inputs**

| Field               | Type            | Required | Description                                                                             |
| ------------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Company             | select (string) | Yes      | Factorial company to create the employee in. Options load from the selected connection. |
| First Name          | string          | Yes      | The employee's first name.                                                              |
| Last Name           | string          | Yes      | The employee's last name.                                                               |
| Email               | string          | Yes      | The employee's work email address.                                                      |
| Contract Start Date | date            | No       | Start date of the employee's initial contract.                                          |
| Manager             | select (string) | No       | The employee's manager. Options load from the selected connection.                      |
| Team                | select (string) | No       | Team to add the employee to. Options load from the selected connection.                 |
| Legal Entity        | select (string) | No       | Legal entity the employee belongs to. Options load from the selected connection.        |
| Phone Number        | string          | No       | The employee's phone number.                                                            |

**Outputs**

| Field       | Type    | Description                 |
| ----------- | ------- | --------------------------- |
| Employee    | dict    | The created employee.       |
| Employee ID | integer | ID of the created employee. |

#### List Teams

List the teams in the company.

**Inputs**

| Field | Type    | Required | Description                            |
| ----- | ------- | -------- | -------------------------------------- |
| Limit | integer | No       | Maximum teams to return (default 100). |

**Outputs**

| Field    | Type        | Description                                       |
| -------- | ----------- | ------------------------------------------------- |
| Teams    | dict\_array | The company's teams.                              |
| Total    | integer     | Total number of teams.                            |
| Has More | boolean     | True if more teams exist beyond the returned set. |

#### List Leaves

List time-off leaves, with employee, type, date, and approval filters.

**Inputs**

| Field           | Type            | Required | Description                                                                             |
| --------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Employee        | select (string) | No       | Return only leaves of this employee. Options load from the selected connection.         |
| Leave Type      | select (string) | No       | Return only leaves of this type. Options load from the selected connection.             |
| From Date       | date            | No       | Return only leaves starting on or after this date.                                      |
| To Date         | date            | No       | Return only leaves starting on or before this date.                                     |
| Approval Status | select (string) | No       | Filter by approval status (default any). Available values: Any, Approved, Not Approved. |
| Limit           | integer         | No       | Maximum leaves to return (default 100).                                                 |

**Outputs**

| Field    | Type        | Description                                        |
| -------- | ----------- | -------------------------------------------------- |
| Leaves   | dict\_array | The time-off leaves matching the filters.          |
| Total    | integer     | Total leaves matching the filters.                 |
| Has More | boolean     | True if more leaves exist beyond the returned set. |

#### List Contracts

List contract versions, with optional employee and date filters.

**Inputs**

| Field        | Type            | Required | Description                                                                        |
| ------------ | --------------- | -------- | ---------------------------------------------------------------------------------- |
| Employee     | select (string) | No       | Return only contracts of this employee. Options load from the selected connection. |
| Effective On | date            | No       | Return only the contract versions effective on this date.                          |
| Limit        | integer         | No       | Maximum contracts to return (default 100).                                         |

**Outputs**

| Field     | Type        | Description                                                   |
| --------- | ----------- | ------------------------------------------------------------- |
| Contracts | dict\_array | The contract versions matching the filters.                   |
| Total     | integer     | Total contract versions matching the filters.                 |
| Has More  | boolean     | True if more contract versions exist beyond the returned set. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/factorial.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
