API lifecycle - Lucca API

This page lists all endpoints available in the Lucca API (2024-11-01), grouped by resource family.

Status	Meaning
Stable	Generally available. No breaking changes without a new API version.
Beta	In beta. May change, including breaking changes, without prior notice.
Deprecated	Deprecated. Will be removed in a future version.

51 endpoints total — 8 stable, 43 beta, 0 deprecated

employee-attributes

Method	Path	Summary	Status
`GET`	`/lucca-api/employee-attribute-definitions`	List employee-attribute-definitions	Beta
`GET`	`/lucca-api/employee-attribute-definitions/{id}`	Retrieve an employee-attribute-definition	Beta
`GET`	`/lucca-api/employee-attributes`	List employee-attributes	Beta
`GET`	`/lucca-api/employee-attributes/{id}`	Retrieve an employee-attribute	Beta

employee-job-qualifications

Method	Path	Summary	Status
`GET`	`/lucca-api/professions`	List professions	Beta
`GET`	`/lucca-api/professions/{id}`	Retrieve a profession	Beta
`GET`	`/lucca-api/job-qualifications`	List job-qualifications	Beta
`GET`	`/lucca-api/job-qualifications/{id}`	Retrieve a job-qualification	Beta

employee-occupation-categories

Method	Path	Summary	Status
`GET`	`/lucca-api/occupation-categories`	List occupation-categories	Beta
`GET`	`/lucca-api/occupation-categories/{id}`	Retrieve an occupation-category	Beta

employees

Method	Path	Summary	Status
`GET`	`/lucca-api/employees`	List employees	Beta
`GET`	`/lucca-api/employees/{id}`	Retrieve an employee	Beta
`GET`	`/lucca-api/portraits/{id}`	Retrieve/Download a portrait	Beta
`GET`	`/lucca-api/employee-personal-records`	List employee-personal-records	Beta
`GET`	`/lucca-api/employee-personal-records/{id}`	Retrieve an employee-personal-record	Beta

employments

Method	Path	Summary	Status
`GET`	`/lucca-api/employments`	List employments	Beta
`GET`	`/lucca-api/employments/{id}`	Retrieve an employment	Beta
`GET`	`/lucca-api/employment-templates`	List employment-templates	Beta
`GET`	`/lucca-api/employment-templates/{id}`	Retrieve an employment-template	Beta
`GET`	`/lucca-api/job-positions`	List job-positions	Beta
`GET`	`/lucca-api/job-positions/{id}`	Retrieve a job-position	Beta
`GET`	`/lucca-api/probationary-periods`	List probationary-periods	Beta
`GET`	`/lucca-api/probationary-periods/{id}`	Retrieve a probationary-period	Beta

events

Method	Path	Summary	Status
`GET`	`/lucca-api/events`	List events	Beta
`GET`	`/lucca-api/events/{id}`	Retrieve an event	Beta

files

Method	Path	Summary	Status
`POST`	`/lucca-api/files`	Upload a file	Beta
`GET`	`/lucca-api/files/{id}`	Retrieve a file	Beta

organization

Method	Path	Summary	Status
`GET`	`/lucca-api/legal-entities`	List legal-entities	Stable
`GET`	`/lucca-api/legal-entities/{id}`	Retrieve a legal-entity	Stable
`GET`	`/lucca-api/business-establishments`	List business-establishments	Stable
`GET`	`/lucca-api/business-establishments/{id}`	Retrieve a business-establishment	Stable
`GET`	`/lucca-api/departments`	List departments	Stable
`POST`	`/lucca-api/departments`	Create a department	Stable
`GET`	`/lucca-api/departments/{id}`	Retrieve a department	Stable
`PATCH`	`/lucca-api/departments/{id}`	Update a department	Stable

taxonomies

Method	Path	Summary	Status
`GET`	`/lucca-api/taxonomies`	List taxonomies	Beta
`GET`	`/lucca-api/taxonomies/{id}`	Retrieve a taxonomy	Beta
`GET`	`/lucca-api/taxonomy-labels`	List taxonomy-labels	Beta
`GET`	`/lucca-api/taxonomy-labels/{id}`	Retrieve a taxonomy-label	Beta

webhooks

Method	Path	Summary	Status
`GET`	`/lucca-api/webhook-endpoints`	List webhook-endpoints	Beta
`POST`	`/lucca-api/webhook-endpoints`	Create a webhook-endpoint	Beta
`GET`	`/lucca-api/webhook-endpoints/{id}`	Retrieve a webhook-endpoint	Beta
`PATCH`	`/lucca-api/webhook-endpoints/{id}`	Update a webhook-endpoint	Beta
`DELETE`	`/lucca-api/webhook-endpoints/{id}`	Delete a webhook-endpoint	Beta
`GET`	`/lucca-api/webhook-deliveries`	List webhook-deliveries	Beta
`POST`	`/lucca-api/webhook-deliveries`	Trigger a test delivery	Beta
`GET`	`/lucca-api/webhook-deliveries/{id}`	Retrieve a webhook-delivery	Beta
`GET`	`/lucca-api/webhook-delivery-attempts`	List webhook-delivery-attempts	Beta
`GET`	`/lucca-api/webhook-delivery-attempts/{id}`	Retrieve a webhook-delivery-attempt	Beta

working-time-arrangements

Method	Path	Summary	Status
`GET`	`/lucca-api/working-time-arrangements`	List working-time-arrangements	Beta
`GET`	`/lucca-api/working-time-arrangements/{id}`	Retrieve a working-time-arrangement	Beta