Security: OAuth 2.0
Security: OAuth 2.0
employments.readonly
employments.readwrite
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
Headers
Only execute the request if current cached version of the resource does not match the one given here.
"W/q5sd4w2x1c1gfdg"
Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.
"W/q5sd4w2x1c1gfdg"
List of compression algorithms you support.
Path Parameters
Identifier of the employment.
1
Query Parameters
Include metadata:
embedded
: the partial or complete representations of related resources (e.g. the employee the resource belongs to).links
: links to related resources or actions (e.g. approving a leave-request). May benull
when you do not have access to the resource (or action).totalCount
: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.
Read more about expanding responses.
Response
OK
The employment resource represents a relationship between an employee and a legal-entity over a continuous period. It may actually represent a work contract, an internship agreement, a contractor's contract, etc...
The actual job of the employee is defined through the job-position resource, which references an employment. Over the course of his/her employment, the employee may occupy several job-positions. Embedded resources on a employment(s) response. An employment resource.
Reference to a legal-entity resource. Read-only. Reference to a legal-entity. Inferred from the business-establishment of its first job-position.
Reference to an employment-template resource.
1
"employment"
Resource identifier in a third-party system.
1 - 200
Reference to an employee resource.
Read-only. The employee status is calculated from the employee's employments.
- active: employee has an employment as of today.
- upcoming: employee currently has no employment but will have one in the future.
- deactivated: employee used to have an employment but no longer does.
active
, upcoming
, deactivated
"active"
Read-only. UTC timestamp of the moment this object was created.
"2023-01-23T12:45:23.1234Z"
Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.
"2023-01-23T12:45:23.1234Z"