HR & people

Employees, departments, positions, benefits and responsibilities — automate HR data flows.

Employee

Endpoints

GET	/employees	Retrieves the collection of Employee resources.
POST	/employees	Creates a Employee resource.
GET	/employees/{id}	Retrieves a Employee resource.
PATCH	/employees/{id}	Updates the Employee resource.
DELETE	/employees/{id}	Removes the Employee resource.
GET	/employees/{id}/documents	Retrieves a Employee resource.
GET	/employees/{id}/feedback-suggestion	Retrieves a Employee resource.
GET	/employees/{id}/project-rates	Retrieves a Employee resource.
POST	/employees/{id}/user	Creates a Employee resource.
DELETE	/employees/{id}/user	Removes the Employee resource.
GET	/employees/{id}/working-hours-stats/{date}	Retrieves a Employee resource.
GET	/employees/me	Retrieves the collection of Employee resources.
GET	/employees/preview	Retrieves the collection of Employee resources.
GET	/employees/search	Retrieves the collection of Employee resources.
GET	/people	Retrieves the collection of Employee resources.
POST	/people	Creates a Employee resource.
GET	/people/{id}	Retrieves a Employee resource.
PATCH	/people/{id}	Updates the Employee resource.
DELETE	/people/{id}	Removes the Employee resource.
GET	/people/{id}/documents	Retrieves a Employee resource.
GET	/people/{id}/feedback-suggestion	Retrieves a Employee resource.
GET	/people/{id}/project-rates	Retrieves a Employee resource.
GET	/people/{id}/review-context-snapshot	Retrieves a Employee resource.
POST	/people/{id}/user	Creates a Employee resource.
DELETE	/people/{id}/user	Removes the Employee resource.
GET	/people/{id}/working-hours-stats/{date}	Retrieves a Employee resource.
GET	/people/me	Retrieves the collection of Employee resources.
GET	/people/preview	Retrieves the collection of Employee resources.
GET	/people/search	Retrieves the collection of Employee resources.

Department

Endpoints

GET	/departments	Retrieves the collection of Department resources.
POST	/departments	Creates a Department resource.
GET	/departments/{id}	Retrieves a Department resource.
PATCH	/departments/{id}	Updates the Department resource.

Schema fields

Field	Type	Description
name	string
code	stringnull
manager	string,null (iri-reference)

Position

Endpoints

GET	/positions	Retrieves the collection of Position resources.
POST	/positions	Creates a Position resource.
GET	/positions/{id}	Retrieves a Position resource.
PATCH	/positions/{id}	Updates the Position resource.
DELETE	/positions/{id}	Removes the Position resource.

Schema fields

Field	Type	Description
name*	string
roles	array

Benefit

Endpoints

GET	/benefits	Retrieves the collection of Benefit resources.
POST	/benefits	Creates a Benefit resource.
GET	/benefits/{id}	Retrieves a Benefit resource.
PATCH	/benefits/{id}	Updates the Benefit resource.

Schema fields

Field	Type	Description
name*	string
visible	boolean
benefitPrices	array

Employee Note

Endpoints

GET	/employee-notes	Retrieves the collection of EmployeeNote resources.
POST	/employee-notes	Creates a EmployeeNote resource.
GET	/employee-notes/{id}	Retrieves a EmployeeNote resource.
PATCH	/employee-notes/{id}	Updates the EmployeeNote resource.
DELETE	/employee-notes/{id}	Removes the EmployeeNote resource.
GET	/people-notes	Retrieves the collection of EmployeeNote resources.
POST	/people-notes	Creates a EmployeeNote resource.
GET	/people-notes/{id}	Retrieves a EmployeeNote resource.
PATCH	/people-notes/{id}	Updates the EmployeeNote resource.
DELETE	/people-notes/{id}	Removes the EmployeeNote resource.

Schema fields

Field	Type	Description
employee*	string (iri-reference)
note*	string

Responsibility

Endpoints

GET	/responsibilities	Retrieves the collection of Responsibility resources.
POST	/responsibilities	Creates a Responsibility resource.
GET	/responsibilities/{id}	Retrieves a Responsibility resource.
PATCH	/responsibilities/{id}	Updates the Responsibility resource.

Schema fields

Field	Type	Description
parent	mixed
responsibilityGroup*	string (iri-reference)
name*	string
description	string
children	array

Feedback

Endpoints

GET	/feedback	Retrieves the collection of Feedback resources.
POST	/feedback	Creates a Feedback resource.
GET	/feedback/{id}	Retrieves a Feedback resource.

Schema fields

Field	Type	Description
employee*	string,null (iri-reference)
authorEmployee*	string,null (iri-reference)
description*	string
details	stringnull
visibility*	string
rate*	string

Employee Benefit

Endpoints

GET	/employee-benefits	Retrieves the collection of EmployeeBenefit resources.
POST	/employee-benefits	Creates a EmployeeBenefit resource.
GET	/employee-benefits/{id}	Retrieves a EmployeeBenefit resource.
PATCH	/employee-benefits/{id}	Updates the EmployeeBenefit resource.
GET	/people-benefits	Retrieves the collection of EmployeeBenefit resources.
POST	/people-benefits	Creates a EmployeeBenefit resource.
GET	/people-benefits/{id}	Retrieves a EmployeeBenefit resource.
PATCH	/people-benefits/{id}	Updates the EmployeeBenefit resource.

Schema fields

Field	Type	Description
employee*	string (iri-reference)
benefit*	string (iri-reference)
dateFrom*	string (date-time)
dateTo	string,null (date-time)

Employee BHP

Endpoints

GET	/employee-bhps	Retrieves the collection of EmployeeBhp resources.
POST	/employee-bhps	Creates a EmployeeBhp resource.
GET	/employee-bhps/{id}	Retrieves a EmployeeBhp resource.
PATCH	/employee-bhps/{id}	Updates the EmployeeBhp resource.
GET	/people-bhps	Retrieves the collection of EmployeeBhp resources.
POST	/people-bhps	Creates a EmployeeBhp resource.
GET	/people-bhps/{id}	Retrieves a EmployeeBhp resource.
PATCH	/people-bhps/{id}	Updates the EmployeeBhp resource.

Schema fields

Field	Type	Description
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo	string,null (date-time)
note	stringnull

Benefit Price

Endpoints

POST	/benefit-prices	Creates a BenefitPrice resource.
GET	/benefit-prices/{id}	Retrieves a BenefitPrice resource.
PATCH	/benefit-prices/{id}	Updates the BenefitPrice resource.
DELETE	/benefit-prices/{id}	Removes the BenefitPrice resource.

Schema fields

Field	Type	Description
id	integer
benefit*	string (iri-reference)
validFrom*	string (date-time)
validTo	string,null (date-time)
price*	number
taxPercent*	number
defaultCompanyCoverageAmount*	number
createdAt	string (date-time)
updatedAt	string (date-time)
dateFrom	string (date-time)
dateTo	string,null (date-time)
employee	string,null (iri-reference)

Position Responsibility

Endpoints

GET	/position-responsibilities	Retrieves the collection of PositionResponsibility resources.
POST	/position-responsibilities	Creates a PositionResponsibility resource.
GET	/position-responsibilities/{id}	Retrieves a PositionResponsibility resource.
DELETE	/position-responsibilities/{id}	Removes the PositionResponsibility resource.

Schema fields

Field	Type	Description
position	string,null (iri-reference)
responsibility	string,null (iri-reference)

Responsibility Employee

Endpoints

GET	/responsibility-employees	Retrieves the collection of ResponsibilityEmployee resources.
POST	/responsibility-employees	Creates a ResponsibilityEmployee resource.
GET	/responsibility-employees/{id}	Retrieves a ResponsibilityEmployee resource.
PATCH	/responsibility-employees/{id}	Updates the ResponsibilityEmployee resource.
DELETE	/responsibility-employees/{id}	Removes the ResponsibilityEmployee resource.

Schema fields

Field	Type	Description
id	integer
responsibility*	string,null (iri-reference)
employee*	string,null (iri-reference)
percentage*	integer
targets	string
description	string
createdAt	string (date-time)
updatedAt	string (date-time)

Responsibility Group

Endpoints

GET	/responsibility-groups	Retrieves the collection of ResponsibilityGroup resources.
POST	/responsibility-groups	Creates a ResponsibilityGroup resource.
GET	/responsibility-groups/{id}	Retrieves a ResponsibilityGroup resource.
PATCH	/responsibility-groups/{id}	Updates the ResponsibilityGroup resource.

Schema fields

Field	Type	Description
responsibleEmployee*	string,null (iri-reference)
name*	string
description	string
responsibilities	array

Employee Transaction

Endpoints

GET	/employee-transactions	Retrieves the collection of EmployeeTransaction resources.
POST	/employee-transactions	Creates a EmployeeTransaction resource.
PATCH	/employee-transactions/{id}	Updates the EmployeeTransaction resource.
DELETE	/employee-transactions/{id}	Removes the EmployeeTransaction resource.

Schema fields

Field	Type	Description
employee	string (iri-reference)
amount	stringnull

Employee Transaction Attachment

Endpoints

GET	/employee-transaction-attachments	Retrieves the collection of EmployeeTransactionAttachment resources.
POST	/employee-transaction-attachments	Creates a EmployeeTransactionAttachment resource.
PATCH	/employee-transaction-attachments/{id}	Updates the EmployeeTransactionAttachment resource.
DELETE	/employee-transaction-attachments/{id}	Removes the EmployeeTransactionAttachment resource.

Schema fields

Field	Type	Description
employee	string (iri-reference)
transactionAttachment	string (iri-reference)
netAmount	integernull
costType	stringnull	Cost component this allocation belongs to (App\Enum\EmployeeCostType value); null = untyped.

Feedback Request

Endpoints

GET	/feedback-requests	Retrieves the collection of FeedbackRequest resources.
POST	/feedback-requests	Creates a FeedbackRequest resource.
GET	/feedback-requests/{id}	Retrieves a FeedbackRequest resource.

Schema fields

Field	Type	Description
id	string
requestedEmployee*	string,null (iri-reference)
employeeFor*	string,null (iri-reference)

Objective

Endpoints

GET	/objectives	Retrieves the collection of Objective resources.
POST	/objectives	Creates a Objective resource.
GET	/objectives/{id}	Retrieves a Objective resource.
PATCH	/objectives/{id}	Updates the Objective resource.
DELETE	/objectives/{id}	Removes the Objective resource.

Schema fields

Field	Type	Description
id	string
title*	string
owner*	string (iri-reference)
ownerLevel	string
department	string,null (iri-reference)
unit	string
periodStart	string,null (date-time)
periodEnd	string,null (date-time)
alignsTo	string,null (iri-reference)
reviewCycle	string,null (iri-reference)
tags	array
createdBy	string (iri-reference)
keyResults	array
createdAt	string (date-time)
updatedAt	string (date-time)
ownerName	stringnull	Owner's display name, embedded in the read payload so the UI never has to resolve it through a separately-permissioned /employees lookup (which a viewer may not have access to, leaving cards showing only the level chip).

Discussion

Endpoints

GET	/discussions	Retrieves the collection of Discussion resources.
POST	/discussions	Creates a Discussion resource.
GET	/discussions/{id}	Retrieves a Discussion resource.
PATCH	/discussions/{id}	Updates the Discussion resource.
POST	/discussions/{id}/messages	Creates a Discussion resource.
GET	/discussions/inbox	Retrieves the collection of Discussion resources.

Schema fields

Field	Type	Description
status	string