> ## Documentation Index
> Fetch the complete documentation index at: https://developers.luccasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API lifecycle

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

| Status                                                | Meaning                                                                |
| :---------------------------------------------------- | :--------------------------------------------------------------------- |
| <Badge color="green" shape="rounded">Stable</Badge>   | Generally available. No breaking changes without a new API version.    |
| <Badge color="orange" shape="rounded">Beta</Badge>    | In beta. May change, including breaking changes, without prior notice. |
| <Badge color="red" shape="rounded">Deprecated</Badge> | Deprecated. Will be removed in a future version.                       |

**49 endpoints total** — 8 stable, 41 beta, 0 deprecated

***

## employee-attributes

| Method | Path                                             | Summary                                                                                                                  | Status                                             |
| :----- | :----------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------- |
| `GET`  | `/lucca-api/employee-attribute-definitions`      | [List employee-attribute-definitions](/api-reference/latest/employee-attributes/get-employee-attribute-definitions)      | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/employee-attribute-definitions/{id}` | [Retrieve an employee-attribute-definition](/api-reference/latest/employee-attributes/get-employee-attribute-definition) | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/employee-attributes`                 | [List employee-attributes](/api-reference/latest/employee-attributes/get-employee-attributes)                            | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/employee-attributes/{id}`            | [Retrieve an employee-attribute](/api-reference/latest/employee-attributes/get-employee-attribute)                       | <Badge color="orange" shape="rounded">Beta</Badge> |

***

## employee-job-qualifications

| Method | Path                                 | Summary                                                                                                 | Status                                             |
| :----- | :----------------------------------- | :------------------------------------------------------------------------------------------------------ | :------------------------------------------------- |
| `GET`  | `/lucca-api/professions`             | [List professions](/api-reference/latest/employee-job-qualifications/get-professions)                   | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/professions/{id}`        | [Retrieve a profession](/api-reference/latest/employee-job-qualifications/get-profession)               | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/job-qualifications`      | [List job-qualifications](/api-reference/latest/employee-job-qualifications/get-job-qualifications)     | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/job-qualifications/{id}` | [Retrieve a job-qualification](/api-reference/latest/employee-job-qualifications/get-job-qualification) | <Badge color="orange" shape="rounded">Beta</Badge> |

***

## employee-occupation-categories

| Method | Path                                    | Summary                                                                                                         | Status                                             |
| :----- | :-------------------------------------- | :-------------------------------------------------------------------------------------------------------------- | :------------------------------------------------- |
| `GET`  | `/lucca-api/occupation-categories`      | [List occupation-categories](/api-reference/latest/employee-occupation-categories/get-occupation-categories)    | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/occupation-categories/{id}` | [Retrieve an occupation-category](/api-reference/latest/employee-occupation-categories/get-occupation-category) | <Badge color="orange" shape="rounded">Beta</Badge> |

***

## employees

| Method | Path                                        | Summary                                                                                              | Status                                             |
| :----- | :------------------------------------------ | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------- |
| `GET`  | `/lucca-api/employees`                      | [List employees](/api-reference/latest/employees/get-employees)                                      | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/employees/{id}`                 | [Retrieve an employee](/api-reference/latest/employees/get-employee)                                 | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/portraits/{id}`                 | [Retrieve/Download a portrait](/api-reference/latest/employees/get-portrait)                         | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/employee-personal-records`      | [List employee-personal-records](/api-reference/latest/employees/get-employee-personal-records)      | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/employee-personal-records/{id}` | [Retrieve an employee-personal-record](/api-reference/latest/employees/get-employee-personal-record) | <Badge color="orange" shape="rounded">Beta</Badge> |

***

## employments

| Method | Path                                   | Summary                                                                                      | Status                                             |
| :----- | :------------------------------------- | :------------------------------------------------------------------------------------------- | :------------------------------------------------- |
| `GET`  | `/lucca-api/employments`               | [List employments](/api-reference/latest/employments/get-employments)                        | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/employments/{id}`          | [Retrieve an employment](/api-reference/latest/employments/get-employment)                   | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/employment-templates`      | [List employment-templates](/api-reference/latest/employments/get-employment-templates)      | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/employment-templates/{id}` | [Retrieve an employment-template](/api-reference/latest/employments/get-employment-template) | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/job-positions`             | [List job-positions](/api-reference/latest/employments/get-job-positions)                    | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/job-positions/{id}`        | [Retrieve a job-position](/api-reference/latest/employments/get-job-position)                | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/probationary-periods`      | [List probationary-periods](/api-reference/latest/employments/get-probationary-periods)      | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/probationary-periods/{id}` | [Retrieve a probationary-period](/api-reference/latest/employments/get-probationary-period)  | <Badge color="orange" shape="rounded">Beta</Badge> |

***

## files

| Method | Path                    | Summary                                                 | Status                                             |
| :----- | :---------------------- | :------------------------------------------------------ | :------------------------------------------------- |
| `POST` | `/lucca-api/files`      | [Upload a file](/api-reference/latest/files/post-files) | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/files/{id}` | [Retrieve a file](/api-reference/latest/files/get-file) | <Badge color="orange" shape="rounded">Beta</Badge> |

***

## organization

| Method  | Path                                      | Summary                                                                                            | Status                                              |
| :------ | :---------------------------------------- | :------------------------------------------------------------------------------------------------- | :-------------------------------------------------- |
| `GET`   | `/lucca-api/legal-entities`               | [List legal-entities](/api-reference/latest/organization/get-legal-entities)                       | <Badge color="green" shape="rounded">Stable</Badge> |
| `GET`   | `/lucca-api/legal-entities/{id}`          | [Retrieve a legal-entity](/api-reference/latest/organization/get-legal-entity)                     | <Badge color="green" shape="rounded">Stable</Badge> |
| `GET`   | `/lucca-api/business-establishments`      | [List business-establishments](/api-reference/latest/organization/list-business-establishments)    | <Badge color="green" shape="rounded">Stable</Badge> |
| `GET`   | `/lucca-api/business-establishments/{id}` | [Retrieve a business-establishment](/api-reference/latest/organization/get-business-establishment) | <Badge color="green" shape="rounded">Stable</Badge> |
| `GET`   | `/lucca-api/departments`                  | [List departments](/api-reference/latest/organization/get-departments)                             | <Badge color="green" shape="rounded">Stable</Badge> |
| `POST`  | `/lucca-api/departments`                  | [Create a department](/api-reference/latest/organization/post-departments)                         | <Badge color="green" shape="rounded">Stable</Badge> |
| `GET`   | `/lucca-api/departments/{id}`             | [Retrieve a department](/api-reference/latest/organization/get-department)                         | <Badge color="green" shape="rounded">Stable</Badge> |
| `PATCH` | `/lucca-api/departments/{id}`             | [Update a department](/api-reference/latest/organization/patch-department)                         | <Badge color="green" shape="rounded">Stable</Badge> |

***

## taxonomies

| Method | Path                              | Summary                                                                          | Status                                             |
| :----- | :-------------------------------- | :------------------------------------------------------------------------------- | :------------------------------------------------- |
| `GET`  | `/lucca-api/taxonomies`           | [List taxonomies](/api-reference/latest/taxonomies/get-taxonomies)               | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/taxonomies/{id}`      | [Retrieve a taxonomy](/api-reference/latest/taxonomies/get-taxonomy)             | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/taxonomy-labels`      | [List taxonomy-labels](/api-reference/latest/taxonomies/get-taxonomy-labels)     | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/taxonomy-labels/{id}` | [Retrieve a taxonomy-label](/api-reference/latest/taxonomies/get-taxonomy-label) | <Badge color="orange" shape="rounded">Beta</Badge> |

***

## webhooks

| Method   | Path                                        | Summary                                                                                            | Status                                             |
| :------- | :------------------------------------------ | :------------------------------------------------------------------------------------------------- | :------------------------------------------------- |
| `GET`    | `/lucca-api/webhook-endpoints`              | [List webhook-endpoints](/api-reference/latest/webhooks/get-webhook-endpoints)                     | <Badge color="orange" shape="rounded">Beta</Badge> |
| `POST`   | `/lucca-api/webhook-endpoints`              | [Create a webhook-endpoint](/api-reference/latest/webhooks/post-webhook-endpoints)                 | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`    | `/lucca-api/webhook-endpoints/{id}`         | [Retrieve a webhook-endpoint](/api-reference/latest/webhooks/get-webhook-endpoint)                 | <Badge color="orange" shape="rounded">Beta</Badge> |
| `PATCH`  | `/lucca-api/webhook-endpoints/{id}`         | [Update a webhook-endpoint](/api-reference/latest/webhooks/patch-webhook-endpoint)                 | <Badge color="orange" shape="rounded">Beta</Badge> |
| `DELETE` | `/lucca-api/webhook-endpoints/{id}`         | [Delete a webhook-endpoint](/api-reference/latest/webhooks/delete-webhook-endpoint)                | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`    | `/lucca-api/webhook-deliveries`             | [List webhook-deliveries](/api-reference/latest/webhooks/get-webhook-deliveries)                   | <Badge color="orange" shape="rounded">Beta</Badge> |
| `POST`   | `/lucca-api/webhook-deliveries`             | [Trigger a test delivery](/api-reference/latest/webhooks/post-webhook-deliveries)                  | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`    | `/lucca-api/webhook-deliveries/{id}`        | [Retrieve a webhook-delivery](/api-reference/latest/webhooks/get-webhook-delivery)                 | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`    | `/lucca-api/webhook-delivery-attempts`      | [List webhook-delivery-attempts](/api-reference/latest/webhooks/get-webhook-delivery-attempts)     | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`    | `/lucca-api/webhook-delivery-attempts/{id}` | [Retrieve a webhook-delivery-attempt](/api-reference/latest/webhooks/get-webhook-delivery-attempt) | <Badge color="orange" shape="rounded">Beta</Badge> |

***

## working-time-arrangements

| Method | Path                                        | Summary                                                                                                             | Status                                             |
| :----- | :------------------------------------------ | :------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------- |
| `GET`  | `/lucca-api/working-time-arrangements`      | [List working-time-arrangements](/api-reference/latest/working-time-arrangements/get-working-time-arrangements)     | <Badge color="orange" shape="rounded">Beta</Badge> |
| `GET`  | `/lucca-api/working-time-arrangements/{id}` | [Retrieve a working-time-arrangement](/api-reference/latest/working-time-arrangements/get-working-time-arrangement) | <Badge color="orange" shape="rounded">Beta</Badge> |