Early access
Adding a new hire from another ATS
Create a new hire as a person in PeopleForce via the Company API.
When you hire someone in an external ATS and want them in PeopleForce without extra manual work, create them through the Company API.
Prerequisite: an API key. If you don't have one, start with Authentication.
Creating a person via the API
A person record is the account an employee uses to log in. It stores the core information about them — name, date of birth, email, phone number, hire date, and more.
Create a person with POST /api/v4/people:
curl -X POST https://app.peopleforce.io/api/v4/people \
-H "X-API-KEY: <your_api_key>" \
-H "Content-Type: application/json" \
-d '{
"first_name": "Andrew",
"last_name": "Doe",
"email": "andrew@example.com",
"hired_on": "2026-07-01"
}'See Create a person in the Company API reference for the full
field list. The accepted personal attributes are: first_name (required),
last_name (required), middle_name, person_number, email (work email),
personal_email, mobile_number, work_phone_number, date_of_birth,
hired_on, and gender (passed by name).
Custom fields
Set custom fields by passing each one as a top-level key equal to its
internal_name — there's no separate wrapper object:
{
"first_name": "Andrew",
"last_name": "Doe",
"tax_number": "123123"
}A field's internal_name is generated from its label and can be looked up with
GET /api/v4/person_fields. For select fields, pass the option value as a
string; for multi-selects, pass an array of values.
Org placement isn't part of create. Department, division, job title, manager, location, and employment type are kept as separate, effective-dated records (so promotions and moves preserve history) rather than fields on the person. Those sub-resources are part of the v4 roadmap but are not yet available in the live API — check the API reference for what's currently mounted, and set org placement in the PeopleForce UI in the meantime.
Troubleshooting
Validation errors (422). Check the response message — you may be missing a required field or sending invalid/duplicate data. Personal and work emails and the personal phone number must be unique; first and last name are required.
If your company legitimately has non-unique emails or phone numbers, contact us.
If the person already exists, you'll get a 422. Look them up by email with
List people (GET /api/v4/people), then update them by ID
with PUT /api/v4/people/{id}.
If your ATS can't call an API directly, check whether it integrates with Zapier — Zapier can sit in between, receive your new hire, and call the PeopleForce API for you.