At a glance
- Availability: Experimental (how to enable).
- Auth: API key.
- Connection: The key from
FACTORIAL_API_KEYis sent as thex-api-keyheader. - Docs: https://apidoc.factorialhr.com/docs/api-keys
Credentials
Set these per environment. See Connect an integration.| Variable | Required | Description |
|---|---|---|
FACTORIAL_API_KEY | Yes | Factorial API key, sent without any prefix in the x-api-key header. API keys grant total access and never expire, so store securely. Docs. |
Setup
- Get a Factorial account with admin access: Sign up at factorialhr.com (a free trial is available) or use an existing company account. Only administrators with full permissions can create and manage API keys.
- Create an API key: As an administrator, generate an API key from the Factorial platform user interface (see https://help.factorialhr.com/how-to-create-api-keys-in-factorial). Copy the key value.
- Store the key: Set the key as FACTORIAL_API_KEY. It is sent as-is in the x-api-key header, without any prefix.
- Factorial API keys grant TOTAL access to the account and never expire - rotate them carefully and keep them secret.
- The API is date-versioned per quarter (this connector uses the 2026-04-01 version); each version is supported for one year after release.
- Regular (non-admin) users see a restricted version of employee data; admin-generated keys see everything.
Tools
| Tool | Access | Description |
|---|---|---|
| List Employees | Read | List employees in the Factorial account, with filters for name, activity status, and team |
| Get Employee | Read | Get a single Factorial employee record by ID |
| List Leaves | Read | List time-off leaves (absences) with filters for employee, date range, and approval status |
| Create Leave | Write | Create a time-off leave (absence) for an employee, such as vacation or sick leave |
| List Teams | Read | List all teams in the Factorial account, useful before filtering employees by team |
| List Leave Types | Read | List the leave types configured in the account (vacation, sick leave, …) with their IDs - required to pick a valid leave_type_id for Create Leave |
| Delete Leave | Write | Delete (cancel) a leave request by its ID |
Example prompts
- List Factorial leaves overlapping the current week and summarize who is away, for how long, and whether the leave is approved.
- List Factorial teams, then list the active employees of a team I pick and summarize the roster.