Adding a new hire from another ATS
Create a new hire as an employee 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 an employee via the API
An employee profile is the account an employee uses to log in. It stores their core information — name, date of birth, email, phone number, hire date, and more.
Create an employee with POST /employees:
curl -X POST https://app.peopleforce.io/api/v3/employees \
-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": "2024-07-01"
}'You can also provide middle name, work and personal email, hire date, position, department, division, manager ID, and any custom field. See Create an employee in the API reference for the full field list.
Custom fields
Address a custom field by its identifier. In v1 custom fields are keyed by
the field's UUID; from v2 onward they're keyed by the generated
internal_name. Look up the identifier with the List employee fields
endpoint.
{
"first_name": "Andrew",
"tax_number": "123123"
}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 the employee already exists you'll get a 422. Look them up by email with
List employees (GET /employees), then update them with
PUT /employees/{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.