Apiv3 Factorialhr Factorial HR API

What authentication does the Factorial HR API use?

Factorial uses HTTP Bearer authentication. Generate an API token from the workspace settings and pass it as Authorization: Bearer <token> on every call. Through Jentic the token is stored encrypted in the vault and injected at call time, so it never enters the agent's prompt context.

Can I run payroll itself with this API?

Not directly. The payroll surface in this version exposes /resources/payroll/supplements only - you can add bonuses, commissions, and other supplements that feed the next payroll cycle, but the actual payroll run is triggered inside the Factorial workspace by a payroll administrator.

What are the rate limits for the Factorial HR API?

Factorial does not document a numeric rate limit in the spec; limits are applied per workspace and surfaced via 429 responses when exceeded. Treat batch operations (e.g. employee list + per-employee document fetches) as paginated and back off on 429.

How do I create a time-off request through Jentic?

Run pip install jentic, then search Jentic for 'submit a time-off request', load the schema for POST /resources/time_off/leaves, and execute it with the employee ID, start_on, end_on, and the policy. Jentic injects the bearer token from your stored Factorial credentials. Run it through Jentic One, the self-hosted execution layer.

Does the API expose the employee directory in real time?

Yes. GET /resources/core/employees returns the live employee directory and GET /resources/core/employees/{id} fetches a single record. Pair the list call with GET /resources/core/teams to recover reporting structure for downstream IAM or directory sync.

Can I limit what my agent is allowed to do with the Factorial HR API?

Yes. Because you run Jentic One yourself, your own rules decide which Factorial operations and credentials the agent may use, working as a positive allow-list so it can only call the operations you have added. You can restrict it to read-only work like listing employees via GET /resources/core/employees and submitting leave via POST /resources/time_off/leaves, while leaving out writes such as creating employee records or posting payroll supplements. Any operation you have not added stays off limits to the agent.