Factorial API Directory

Factorial HR is a robust cloud-based human resources management software designed to streamline and automate a wide array of HR processes for businesses. Tailored to meet the needs of companies of all sizes, from small startups to large enterprises, Factorial HR offers a user-friendly platform that simplifies the complexities of human resources management. By centralizing employee information and automating routine tasks, it empowers HR professionals to focus on strategic initiatives that drive organizational growth.

At its core, Factorial HR excels in employee management by consolidating employee data, tracking attendance, and monitoring work hours. It also automates payroll processes, ensuring accurate and timely salary payments while managing deductions. The software facilitates seamless time-off and leave management, performance evaluations, recruitment, and onboarding. Additionally, Factorial HR aids businesses in maintaining compliance with labor laws through comprehensive reporting and documentation capabilities. With its extensive features, Factorial HR is an indispensable tool for businesses seeking to enhance their HR operations and employee experience.

Key highlights of Factorial HR APIs

Core Functionalities:

• Employee Management: Access and manage detailed information about employees, including personal details, employment history, and contact information.
• Time Off Management: Retrieve and handle data related to employee leave requests, balances, and histories.
• Document Management: Create, retrieve, and manage documents associated with employees and the organization.
• Job Catalog: Manage job titles, roles, and levels within the organization.

Integration Use Cases:

• Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems.
• Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
• Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.

Supported Protocols:

• RESTful API: The Factorial HR API follows REST principles, facilitating straightforward HTTP requests and responses.

Authentication Mechanisms:

• API Keys: Suitable for internal company developments, API keys provide a straightforward method to start making requests to the public API.
• OAuth 2.0: Required for marketplace integrations, OAuth 2.0 allows making requests on behalf of a user or a company, providing a secure channel for token exchange.

Rate Limiting Policies:

• Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

For comprehensive information and to get started with the Factorial HR API, refer to their official API documentation.

Factorial HR API Endpoints

Attendance

• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/break_configurations : Create Break Configuration
• PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/break_configurations/{id} : Update Break Configuration
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/estimated_times : Get Estimated Attendance Times for Employees
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/open_shifts : Retrieve Current Open Shifts for Specified Employees
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests : Get Overtime Requests
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests/approve : Approve Overtime Request
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests/reject : Reject Overtime Request
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests/{id} : Get Overtime Request Details
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts : Get All Shifts
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/autofill : Autofill Employee Shifts
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/break_end : End Break in Open Shift
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/break_start : Start Break in Open Shift
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/clock_in : Clock In a Shift
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/clock_out : Clock Out Shift
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/toggle_clock : Toggle Shift Clock In/Out
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/{id} : Get Shift Details
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/worked_times : Get Worked Times

Companies

• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/companies/legal_entities : Get Legal Entities
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/companies/legal_entities/{id} : Get Legal Entity Details

Documents

• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents : Create Document
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents/move_to_trash_bin : Move Documents to Trash Bin
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents/restore_from_trash_bin : Restore Documents from Trash Bin
• PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents/{id} : Update Document
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/download_urls/bulk_create : Generate Temporal URLs for Document Downloads
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/folders : Get All Document Folders
• PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/folders/{id} : Update Folder

Employee Updates

• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/absences : Retrieve Absence Employee Updates
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/contract_changes : Retrieve Employee Contract Change Updates
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/contract_changes/{id} : Retrieve Employee Contract Change Details
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/summaries : Retrieve Employee Updates Summaries
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/summaries/{id} : Retrieve Employee Updates Summary
• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/terminations : Retrieve Termination Employee Updates

Employees

• GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employees/employees : Get Employee Information

Time Off

• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves : Create a Leave
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves/approve : Approve Employee Time-off Requests
• POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves/reject : Reject Employee Time-off Requests
• PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves/{id} : Update Leave Details

Factorial API FAQs

How can I obtain an API key for the Factorial API?

• Answer: Administrators can generate an API key by navigating to the Factorial platform's left sidebar, clicking on "Configuration," selecting the "API" option, and then creating a new API key.
  FactorialHR API Documentation

Can I customize the permissions of the API key in Factorial?

• Answer: No, the API key provides access to all information within the platform and cannot be customized. For more granular access control, consider using OAuth 2.0 to access specific data.
  FactorialHR API Documentation

Does the API key expire?

• Answer: No, the API key does not expire.
  FactorialHR API Documentation

What are the rate limits for the Factorial API?

• Answer: The Factorial API enforces rate limits to ensure fair usage:some text
  • POST requests on /api/v2 endpoints: Limited to 200 requests per minute.
  • POST requests on /api/v1 endpoints: Limited to 100 requests per minute.
    FactorialHR API Documentation

How can I access employee job titles using the Factorial API?

• Answer: Employee job titles are available through the "Contract versions" endpoint. Since each employee can have multiple contract versions, it's essential to retrieve the latest contract version to obtain the current job title.
  FactorialHR API Documentation

Get Started with Factorial API Integration

Knit API offers a convenient solution for quick and seamless integration with Factorial API. Our AI-powered integration platform allows you to build any Factorial API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Factorial API.‍

To sign up for free, click here. To check the pricing, see our pricing page.