Skip to main content

Factorial

Factorial is a cloud-based HR management platform for small and mid-sized businesses. It centralizes HR operations — employee records, time and attendance, shift management, time-off requests, payroll support, document management, and team organization. Its REST API reads and writes HR data, making it straightforward to integrate workforce data into pipelines, analytics, and BI workflows.

Factorial icon

Power end-to-end data operations for your Factorial API with Nexla. Our bi-directional Factorial connector is purpose-built for Factorial, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Factorial or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Factorial workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

To connect Nexla to Factorial, you will need a Factorial API key. API keys are generated by workspace administrators from within the Factorial platform.

Generate a Factorial API Key

Only Factorial workspace administrators can create API keys. Complete the following steps to generate an API key for use with Nexla:

  1. Sign in to your Factorial workspace as an administrator at https://app.factorialhr.com.

  2. In the left sidebar, navigate to Configuration.

  3. Under the Configuration section, select API.

  4. Click the button to create a new API key. Enter a descriptive name for the key (for example, "Nexla Integration") to make it easy to identify later.

  5. After the key is generated, copy it immediately and store it in a secure location. Factorial displays the API key only once—it cannot be retrieved again after you leave the page.

Important

The Factorial API key grants access to all data in your workspace and cannot be scoped to specific resources. Store the key securely and treat it with the same care as a password. If the key is compromised, delete it from the Factorial Configuration → API page and generate a new one.

Determine Your API Version

Factorial uses a date-based API versioning scheme in the format YYYY-MM-DD. A new version is released at the beginning of each quarter (approximately January 1, April 1, July 1, and October 1), and each version is supported for one year.

The default version configured in this connector is 2026-04-01. Review the Factorial API versioning documentation and the Factorial API changelog to confirm the appropriate version for your integration and update it if a newer version is available.

Authenticate

Credentials required

Authenticate using your Factorial HR API key, passed as the X-API-KEY header value.

FieldRequiredSecretDescription
API KeyYesYesYour Factorial HR API key. Generate from Factorial HR dashboard under integrations.
API VersionYesNoFactorial API version (date-based, e.g. 2026-04-01). Update this when Factorial releases a new version (quarterly cadence). See https://apidoc.factorialhr.com/docs/api-versioning

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter the Factorial API key you generated in the API Key field. This key is sent as the X-API-KEY header on every request Nexla makes to the Factorial API, authenticating the connection to your workspace.

    Nexla validates the API key when the credential is saved by making a test request to the Factorial credentials endpoint. If validation fails, verify that the key was copied correctly and that the account has administrator-level access in Factorial.

  4. Enter the Factorial API version in the API Version field. The default value is 2026-04-01. This version string is embedded in the URL path of every API request (for example, https://api.factorialhr.com/api/2026-04-01/resources/...). Update this value when Factorial releases a new quarterly version and you are ready to migrate your integration.

    Factorial releases a new API version each quarter and supports each version for one year. Additional details about the versioning schedule and migration guidance are available in the Factorial API versioning documentation.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Factorial connector tile, then select the credential that will be used to connect to the Factorial instance, and click Next; or, create a new Factorial credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Factorial endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Tasks

Retrieves a paginated list of all tasks in your Factorial organization. Use this endpoint to pull task data for workforce management reporting or to integrate task assignments into downstream systems.

  • No additional parameters are required for this endpoint. Nexla will automatically paginate through all available tasks, fetching up to 100 records per page until all tasks have been retrieved.
  • The endpoint returns task metadata including task IDs, names, assignees, and status information for all tasks configured in your organization.

For additional details about the fields returned by this endpoint, refer to the Factorial Tasks API reference.

List Work Schedules

Retrieves a paginated list of all work schedules configured in your Factorial organization. Use this endpoint to extract scheduling templates for workforce planning analysis or to synchronize schedule definitions with external systems.

  • No additional parameters are required. Nexla will automatically paginate through all available work schedules, fetching up to 100 records per page.
  • Work schedules define the expected working hours, days, and patterns assigned to employees or groups within your organization.

For additional details, refer to the Factorial Work Schedules API reference.

List Teams

Retrieves a paginated list of all teams in your Factorial organization. Use this endpoint to synchronize team structures with HR analytics tools or to build organizational hierarchy reports.

  • No additional parameters are required. Nexla will automatically paginate through all available teams, fetching up to 100 records per page.
  • The response includes team IDs, names, and associated metadata for every team defined in your workspace.

To retrieve the employees assigned to each team, use the List Team Memberships endpoint in combination with this endpoint.

List Team Memberships

Retrieves a paginated list of all team memberships, showing which employees belong to which teams. Use this endpoint to analyze team composition, build org charts, or audit team assignments.

  • No additional parameters are required. Nexla will automatically paginate through all membership records, fetching up to 100 records per page.
  • Each membership record links an employee ID to a team ID, enabling joins with data from the List Employees and List Teams endpoints.

For additional details, refer to the Factorial Team Memberships API reference.

List Time Off Allowances

Retrieves a paginated list of all time off allowances configured for employees. Use this endpoint to audit leave entitlements, report on allowance utilization, or synchronize leave balances with payroll systems.

  • No additional parameters are required. Nexla will automatically paginate through all allowance records, fetching up to 100 records per page.
  • Allowances define the number of leave days or hours each employee is entitled to, organized by leave type and policy.

For additional details, refer to the Factorial Time Off Allowances API reference.

List Blocked Periods

Retrieves a paginated list of all blocked periods—date ranges during which employees cannot submit time off requests. Use this endpoint to identify scheduling constraints or to synchronize blackout dates with workforce planning tools.

  • No additional parameters are required. Nexla will automatically paginate through all blocked period records, fetching up to 100 records per page.
  • Each blocked period record includes the start and end dates of the restriction and any associated policy or leave type constraints.

For additional details, refer to the Factorial Blocked Periods API reference.

List Time Off Requests

Retrieves a paginated list of all time off (leave) requests submitted by employees. Use this endpoint to track leave patterns, monitor pending approvals, or feed leave data into payroll and HR analytics workflows.

  • No additional parameters are required. Nexla will automatically paginate through all leave records, fetching up to 100 records per page.
  • Each record includes the employee ID, leave type, requested dates, and approval status (pending, approved, or rejected).

For additional details, refer to the Factorial Leave Requests API reference.

List Leave Types

Returns a paginated list of all leave types configured in your Factorial system, such as vacation, sick leave, or parental leave. Use this endpoint to retrieve the reference data needed to interpret leave request and allowance records.

  • No additional parameters are required. Nexla will automatically paginate through all leave type records, fetching up to 100 records per page.
  • Leave type IDs returned by this endpoint can be used to cross-reference records from the List Time Off Requests and List Time Off Allowances endpoints.

For additional details, refer to the Factorial Leave Types API reference.

List Timeoff Policies

Returns a paginated list of all time off policies configured in your Factorial organization. Policies define the rules governing how leave types are accrued, approved, and tracked for different employee groups.

  • No additional parameters are required. Nexla will automatically paginate through all policy records, fetching up to 100 records per page.
  • Policy records include accrual rules, carryover settings, and the leave types governed by each policy.

For additional details, refer to the Factorial Timeoff Policies API reference.

List Legal Entities

Returns a paginated list of all legal entities configured in your Factorial company. Use this endpoint to retrieve the company structure needed for multi-entity reporting or to support payroll integrations that require legal entity information.

  • No additional parameters are required. Nexla will automatically paginate through all legal entity records, fetching up to 100 records per page.
  • Legal entities represent distinct legal organizations (such as subsidiaries or regional offices) within your company structure.

For additional details, refer to the Factorial Legal Entities API reference.

List Contract Versions

Returns a paginated list of all contract versions in your Factorial system. Contract versions capture changes to an employee's employment terms over time—such as salary adjustments, role changes, or schedule modifications.

  • No additional parameters are required. Nexla will automatically paginate through all contract version records, fetching up to 100 records per page.
  • Each contract version record is linked to an employee and reflects the terms in effect during a specific date range.

For additional details, refer to the Factorial Contract Versions API reference.

List Employees

Returns a paginated list of all employees in your Factorial organization. This is one of the most commonly used endpoints, providing core workforce data for HR analytics, headcount reporting, and integration with downstream systems.

  • No additional parameters are required. Nexla will automatically paginate through all employee records, fetching up to 100 records per page.
  • Each employee record includes personal details, employment status, job information, and organizational assignments such as team and location.

To retrieve the full details for a single employee record, use the Get Employee endpoint with a specific employee ID.

Get Employee

Retrieves a single employee record by its unique ID. Use this endpoint when you need detailed information about a specific employee or when building a flow that processes individual employee records.

  • Enter the numeric employee ID in the Id field. This value is required. Employee IDs can be obtained from the List Employees endpoint response.

  • The endpoint returns the complete employee record for the specified ID, including all profile fields, employment details, and organizational assignments.

For additional details, refer to the Factorial Get Employee API reference.

List Cost Centers

Returns a paginated list of cost centers used for financial tracking and organizational reporting within your Factorial workspace. Use this endpoint to retrieve cost center reference data for payroll integrations or financial analytics.

  • No additional parameters are required. Nexla will automatically paginate through all cost center records, fetching up to 100 records per page.
  • Cost center records include identifiers and names that can be used to categorize employee expenses and payroll costs.

For additional details, refer to the Factorial Cost Centers API reference.

List Company Holidays

Returns a paginated list of company-wide holidays and non-working days configured in your Factorial workspace. Use this endpoint to synchronize holiday calendars with scheduling, payroll, or workforce planning systems.

  • No additional parameters are required. Nexla will automatically paginate through all holiday records, fetching up to 100 records per page.
  • Holiday records include the date, name, and any regional or policy-based scoping applied to the holiday.

For additional details, refer to the Factorial Company Holidays API reference.

List Locations

Returns a paginated list of office locations and work sites registered in your Factorial organization. Use this endpoint to retrieve location reference data for employee reporting or to synchronize workspace locations with other business systems.

  • No additional parameters are required. Nexla will automatically paginate through all location records, fetching up to 100 records per page.
  • Location records include the location name, address, and any associated configuration details.

For additional details, refer to the Factorial Locations API reference.

List Work Areas

Returns a paginated list of work areas or departments within locations in your Factorial workspace. Work areas are subdivisions of physical locations and can be used to organize employees by functional area within a site.

  • No additional parameters are required. Nexla will automatically paginate through all work area records, fetching up to 100 records per page.
  • Work area records include the work area name, associated location ID, and any related configuration.

For additional details, refer to the Factorial Work Areas API reference.

List Shifts

Returns a paginated list of work shifts configured in the Factorial shift management system. Use this endpoint to retrieve shift definitions for scheduling analysis or to synchronize shift templates with workforce management tools.

  • No additional parameters are required. Nexla will automatically paginate through all shift records, fetching up to 100 records per page.
  • Shift records describe the planned working periods, including start and end times, and any recurrence rules associated with each shift.

For additional details, refer to the Factorial Shifts API reference.

List Attendance Shifts

Retrieves a paginated list of attendance shifts—individual clock-in and clock-out events recorded for employees. Use this endpoint to analyze actual worked hours, audit attendance records, or feed time data into payroll processes.

  • No additional parameters are required for basic retrieval. Nexla will automatically paginate through all attendance shift records, fetching up to 100 records per page.
  • Each attendance shift record captures the employee ID, clock-in time, clock-out time, and the duration of the shift. The Factorial API also supports filtering by employee_ids[], start_on, and end_on parameters for more targeted data retrieval when configuring manually.

For additional details, refer to the Factorial Attendance Shifts API reference.

List Open Shifts

Retrieves a real-time list of employees who are currently clocked in. Use this endpoint to monitor live attendance status or to trigger real-time workflows based on employee check-in events.

  • No additional parameters are required. This endpoint does not use pagination—it returns all currently open shifts in a single response.
  • Each open shift record identifies the employee and the time at which they clocked in. The Factorial API supports filtering by employee_ids[] to narrow results to specific employees when configuring manually.

Because this endpoint reflects real-time status, the results will change as employees clock in and out. Schedule this data flow to run at regular intervals to capture point-in-time snapshots of attendance status.

List Estimated Times

Retrieves planned hours per employee per date, enabling variance reporting between scheduled and actual worked hours. Use this endpoint to compare expected attendance against actual clock-in data for productivity and compliance reporting.

  • No additional parameters are required. This endpoint returns all estimated time records in a single response without pagination.
  • Estimated time records include the employee ID, the target date, and the planned number of hours for that day based on the employee's assigned work schedule.

For additional details, refer to the Factorial Estimated Times API reference.

List Worked Times

Retrieves aggregated worked hours per employee per period—suitable for use as payroll input or for generating time-worked summaries. Use this endpoint when you need consolidated time totals rather than individual clock-in/out events.

  • No additional parameters are required. This endpoint returns all worked time records in a single response without pagination.
  • Each record summarizes the total hours worked by an employee during a given period, aggregated from the underlying attendance shift records.

For additional details, refer to the Factorial Worked Times API reference.

List Overtime Requests

Retrieves a paginated list of overtime approval requests submitted by employees. Use this endpoint to monitor overtime activity, track approval status, or feed overtime data into payroll processing workflows.

  • No additional parameters are required. Nexla will automatically paginate through all overtime request records, fetching up to 100 records per page.
  • Each overtime request record includes the employee ID, the requested overtime period, the number of hours, and the current approval status.

For additional details, refer to the Factorial Overtime Requests API reference.

List Documents

Retrieves a paginated list of document metadata records stored in Factorial. Use this endpoint to audit the document library, track document uploads by employee, or synchronize document metadata with external document management systems.

  • No additional parameters are required. Nexla will automatically paginate through all document records, fetching up to 100 records per page.
  • This endpoint returns document metadata only—it does not return the binary file contents. Each record includes the document name, associated employee, folder, upload date, and other metadata fields.

For additional details, refer to the Factorial Documents API reference.

List Document Folders

Retrieves the document folder hierarchy used to organize documents in Factorial. Use this endpoint to understand the folder structure before synchronizing documents or to reproduce the same folder hierarchy in an external system.

  • No additional parameters are required. Nexla will automatically paginate through all folder records, fetching up to 100 records per page.
  • Each folder record includes the folder ID, name, parent folder ID (for nested folders), and associated metadata.

For additional details, refer to the Factorial Document Folders API reference.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Factorial data sources can also be manually configured to ingest data from any valid Factorial API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Factorial API URLs follow the pattern https://api.factorialhr.com/api/{version}/resources/{resource_path}, where {version} is the date-based API version (for example, 2026-04-01) configured in your credential. For most Factorial list endpoints, set the Path to Data to $.data[*] to extract individual records from the response. Date/time macros are useful for attendance and time-off endpoints that support start_on and end_on query parameters, and lookup-based macros are useful for endpoints that require an employee, team, or legal entity ID in the URL path. You do not need to include the X-API-KEY header in Request Headers—it is automatically included from your Factorial credential. Refer to the full Factorial API reference for endpoint-specific details.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Factorial data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Factorial destination, and select the Send to Destination option from the menu. Select the Factorial connector from the list of available destination connectors, then select the credential that will be used to connect to the Factorial organization, and click Next; or, create a new Factorial credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Factorial endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Employee

Creates a new employee record in your Factorial organization. Use this template to onboard employees in Factorial from an upstream HR system, an HRIS migration workflow, or any data source that produces employee records.

  • No additional path parameters are required. The Nexset data is sent as a JSON body to the Factorial Employees API endpoint using an HTTP POST request.
  • The JSON body should contain the employee fields to be created. Required and optional fields for a new employee record are documented in the Factorial Create Employee API reference. Commonly used fields include:

    • first_name: The employee's first name.
    • last_name: The employee's last name (surname).
    • email: The employee's work email address, used for login and communications.
    • birthday_on: The employee's date of birth in YYYY-MM-DD format.
    • start_date: The employee's employment start date in YYYY-MM-DD format.
  • Each record in the Nexset will be sent as a separate API call, creating one new employee per call.

Factorial requires a valid, unique email address for each new employee. If duplicate email addresses are present in your Nexset, the API will return an error for those records. Use Nexla's data transformation capabilities to deduplicate or validate email fields before sending to this destination.

Update Employee

Updates an existing employee record in Factorial by its unique ID. Use this template to synchronize employee profile changes from an upstream system—such as name changes, address updates, or role changes—into Factorial.

  • Enter the numeric employee ID in the Id field. This value is required and is embedded in the API URL path. The employee ID can be obtained from the List Employees or Get Employee source endpoints.

  • The Nexset data is sent as a JSON body to the Factorial Employees API using an HTTP PUT request. Include only the fields that should be updated in the request body; fields not included in the body will retain their current values.
  • Each record in the Nexset will be sent as a separate API call, updating one employee per call.

The Id field must match an existing employee ID in your Factorial workspace. Sending an ID that does not exist will result in a 404 error from the Factorial API. For additional details, refer to the Factorial Update Employee API reference.

Create Leave

Creates a new time-off (leave) request in Factorial on behalf of an employee. Use this template to submit leave requests programmatically—for example, when synchronizing approved leave from an external system into Factorial.

  • No additional path parameters are required. The Nexset data is sent as a JSON body to the Factorial Leave API using an HTTP POST request.
  • The following fields are required in the request body:

    • employee_id: The numeric ID of the employee for whom the leave is being created.
    • start_on: The start date of the leave period in YYYY-MM-DD format.
    • leave_type_id: The numeric ID of the leave type (e.g., vacation, sick leave). Leave type IDs can be obtained from the List Leave Types source endpoint.
  • Each record in the Nexset will be sent as a separate API call, creating one leave request per call.

For additional details about optional fields (such as finish_on, half_day, and description), refer to the Factorial Create Leave API reference.

Approve Leave

Approves a pending time-off (leave) request in Factorial. Use this template to automate leave approvals—for example, when an upstream approval workflow or HR system signals that a leave request should be approved in Factorial.

  • No additional path parameters are required. The leave ID is passed in the JSON request body, not in the URL path.
  • The following field is required in the request body:

    • id: The numeric ID of the leave request to approve. Leave request IDs can be obtained from the List Time Off Requests source endpoint.
  • Each record in the Nexset will be sent as a separate API call, approving one leave request per call.

Only leave requests that are in a pending state can be approved. Attempting to approve a leave that has already been approved, rejected, or cancelled will result in an error from the Factorial API. For additional details, refer to the Factorial Approve Leave API reference.

Reject Leave

Rejects a pending time-off (leave) request in Factorial. Use this template to automate leave rejections when an upstream workflow or HR policy determines that a leave request should not be approved.

  • No additional path parameters are required. The leave ID is passed in the JSON request body, not in the URL path.
  • The following field is required in the request body:

    • id: The numeric ID of the leave request to reject. Leave request IDs can be obtained from the List Time Off Requests source endpoint.
  • Each record in the Nexset will be sent as a separate API call, rejecting one leave request per call.

Only leave requests in a pending state can be rejected. For additional details, refer to the Factorial Reject Leave API reference.

Manual configuration

Factorial destinations can also be manually configured to send data to any valid Factorial API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Factorial's REST API accepts JSON (application/json) for all write operations. Factorial API URLs follow the pattern https://api.factorialhr.com/api/{version}/resources/{resource_path}; for update operations that require a record ID in the URL path, append the ID at the end of the URL (for example, https://api.factorialhr.com/api/2026-04-01/resources/employees/employees/12345). You do not need to include the X-API-KEY header in Request Headers—it is automatically added from your Factorial credential configuration.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured Factorial endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to Factorial until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.