REST - Employee personal data via API
FollowThis article describes how to read and write the employee personal data through the Altamira REST API. For the general context and the rules common to all organization-chart endpoints refer to the REST - Managing personnel and organization chart via API article.
Endpoints to prepare
- Create an Endpoint/View to read the base personal data. You can add to the view any field you need.
- Create an Endpoint/View to create/update the employee personal data.
Write — create and update
The write endpoint accepts a POST call with a payload in the following shape:
{
"data": [
{
"id": 0,
"Employees_FiscalCode": "CF0000000001",
"Employees_Surname": "LastName",
"Employees_Name": "FirstName",
"Employees_EmailBusiness": "LastName.FirstName@altamira.it",
"Employees_data_assunzione": "2020-01-01T00:00:00Z",
"Employees_ResignationDate": null
}
]
}Mandatory fields
-
id—0to create a new employee, the existing employee identifier to update. -
Employees_FiscalCode— fiscal code, used as an identification key for the employee. -
Employees_Surname— last name. -
Employees_Name— first name. -
Employees_EmailBusiness— business email. -
Employees_data_assunzione— hire date. -
Employees_ResignationDate— resignation date:nullfor active employees.
Additional fields
The fields above are the minimum set. You can add to the view other personal-data fields (phone, address, location, various lookups, custom fields) to meet customer needs: every field added to the view becomes writable through the API by exposing its TagName in the payload.
Resignation of an employee
To resign an employee, run an update (id valued with the employee identifier) where the Employees_ResignationDate field is set to a date before today:
{
"data": [
{
"id": 27160150,
"Employees_ResignationDate": "2026-03-31T00:00:00Z"
}
]
}The employee is marked as resigned from the indicated date.
Read
The read endpoint replies to a GET call and returns the employees contained in the view, with pagination and filters as described in the REST - Read call example article. Add to the view only the fields you actually want to expose to the external system.
Operational notes
- Dates must be in the
"2026-04-02T00:00:00Z"format. - Updates are a full update of the fields included in the view: fields not present in the payload keep their previous value, while fields present are overwritten with the sent value (even if
null).
Permissions
- Read on the Employees entity for GET calls.
- Write on the Employees entity for create/update and for resignation.
Permissions are assigned to the individual user, not to a profile.
Related articles
- REST - Managing personnel and organization chart via API
- REST - Personnel and organization data model
- REST - Organization chart and positions via API
- REST - Employee-position assignments via API
- REST - Common operational scenarios for the organization chart via API
- REST - Read call example
- REST - Write call example
Comments
0 comments
Please sign in to leave a comment.