AI agents for Factorial HR

Get the API key's company

Reads the credentials the key acts with: data, each with company_id (which "Create a candidate" needs), name (the company), legal_name, employee_id, email, role and locale.

Find employees

Lists employees, by default only those not terminated, filtered by name (full text or starting with), email, team, location or employee IDs, or only managers.

Get an employee

Reads one employee by ID.

List time off

Lists leaves (time off), optionally for some employees or leave types, overlapping a date range, only approved, rejected or pending ones.

List leave types

Lists the company's leave types, optionally only active ones or only those an employee's time-off policy grants on a date (give both employee and date).

Get time-off balances

Reads employees' time-off counters per allowance as of a date (today if left out), for up to 25 employees (all the key can see if left out).

List job postings

Lists ATS job postings, optionally of one status (draft, published, unlisted, archived, cancelled) or team, location or legal entity.

Find candidates

Lists ATS candidates, optionally by email, applied job postings, talent-pool membership or archived state.

Get a candidate

Reads one ATS candidate by ID.

List applications

Lists ATS applications, optionally for a job posting, some candidates, a phase or matching a search.

List hiring phases

Lists the application phases (pipeline columns) of job postings.

Record time off

Creates a leave for an employee of a leave type (an ID from "List leave types"), from a start date to an optional end date, optionally as half a day.

Create a candidate

Adds a candidate to the company's ATS with first and last name and, optionally, email, phone, personal URL, source and talent-pool flag.

Apply a candidate to a job

Creates an application of an existing candidate to a job posting, optionally in a given phase (else the posting's first), with a source and cover letter.

Move an application to a phase

Moves an application to another phase of the same job posting (IDs from "List hiring phases"); Factorial may run that phase's automations.

Add a note to a candidate

Adds a feedback entry (a note, optionally with a 1–5 rating) to a candidate, optionally tied to one application and phase.