Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
People

Create company employee.

<br>This endpoint allows you to create a new employee in the system. <br> The request body must include the minimum required fields: email, firstName, surname, and the work object with site and startDate.<br> While not all fields are mandatory, we recommend populating as many fields as possible to ensure complete employee records from the start. <br> Specifically, it's recommended to include work.department and work.title. <br>You can include any additional fields from the Fields Metadata API to enrich the employee's profile during creation.

post/people

Request body

firstNamestring required

Employee's first name. Max length: 50, can only contain letters and ´̀_-;,̩./'’"()`

surnamestring required

Employee's surname. Max length: 50, can only contain letters and ´̀_-;,̩./'’"()`

emailstring email required

Employee's email address. Must be a valid email address, unique within the company

Example request

{
  "firstName": "Joe",
  "surname": "Doe",
  "email": "joe.doe@examplecompany.com",
  "work": {
    "site": "New York",
    "startDate": "2024-01-01",
    "department": "Accounting",
    "title": "Chief Engineer"
  }
}

Response

Employee

fullNamestring

The full name of the Employee (first name + surname).

/work/indirectReportsstring[]

The internal IDs of the people the Employee reports to indirectly.

displayNamestring

Employee's display name. This defaults to first name & last name but can be customized.

creationDateTimestring

The full timestamp of creation of the Employee.

avatarUrlstring

The URL of the source of the avatar image.

secondNamestring

Employee's surname.

companyIdnumber

The ID of the employee's company.

emailstring email

Employee's email address.

surnamestring

Employee's surname.

coverImageUrlstring

The URL of the cover image.

idstring

A unique identifier representing a specific employee.

firstNamestring

Employee's first name.