Create company employee.


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

Body Params
string
required

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

string
required

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

string
required

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

work
object
required
Responses

400

Bad request. The request contains incorrect parameters or syntax errors. Please review the request body

403

Forbidden. The service user does not have permissions to access this table or employees. Check the permissions as explained in the endpoint description.

429

"Too Many Requests" error. This indicates that you've exceeded the rate limit for requests. Please verify that you are using the correct endpoint with the POST method. Additionally, check the HTTP headers for rate limit information, such as the number of requests allowed and the time until the limit resets. For more details, see Rate Limiting.

Language
Credentials
Basic
base64
:
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json