Skip to main content
Lucca
Lucca
47 actions · 12 events · 2 auth methods
BetaHRIS

​
Authentication

OAuth 2.0

OAuth 2.0 Client Credentials flow for the Lucca API (v5). Recommended for new integrations.Guides: Connector Profile, Link Account

API Key

Legacy API key authentication for Lucca v3/v4 APIs. Each key has role-based access rights.Guides: Connector Profile, Link Account
Actions
|
47 actions
Action
Description
Required scopes
List Employees
Returns a paginated list of employees.
Retrieve An Employee
Retrieve a single employee.
Retrieve/Download A Portrait
Retrieve a single employee portrait, either as a JSON representation, or the actual image file.
List Employee-personal-records
Retrieve a paginated list of employee-personal-records.
Retrieve An Employee-personal-record
Retrieve an employee-personal-record.
List Departments
Returns a paginated list of departments.
Retrieve A Department
Retrieve a single department by ID.
Create A Department
Create a new department.
Update A Department
Update a department.
List Legal-entities
Returns a paginated list of legal-entities.
Retrieve A Legal-entity
Retrieve a legal-entity.
List Business-establishments
List business-establishments.
Retrieve A Business-establishment
Retrieve a business-establishment.
List Employments
Returns a paginated list of employments.
Retrieve An Employment
Retrieve an employment by its ID.
List Employment-templates
Retrieve a paginated list of employment-templates.
Retrieve An Employment-template
Retrieve an employment-template by its ID.
List Job-positions
Retrieve a paginated list of job-positions.
Retrieve A Job-position
Retrieve a job-position by its ID.
List Probationary-periods
List probationary-periods.
Retrieve A Probationary-period
Retrieve a probationary-period by its ID.
List Employee-attribute-definitions
Returns a paginated list of employee-attribute-definitions.
Retrieve An Employee-attribute-definition
Retrieve a single employee-attribute-definition by ID.
List Employee-attributes
Returns a paginated list of employee-attributes.
Retrieve An Employee-attribute
Retrieve a single employee-attribute by ID.
List Professions
List professions.
Retrieve A Profession
Retrieve a profession by its ID.
List Job-qualifications
Returns a paginated list of job-qualifications.
Retrieve A Job-qualification
Retrieve a job-qualification by its ID.
List Occupation-categories
Returns a paginated list of occupation-categories.
Retrieve An Occupation-category
Retrieve an occupation-category.
List Taxonomies
Returns a paginated list of taxonomies.
Retrieve A Taxonomy
Retrieve a taxonomy by its ID.
List Taxonomy-labels
Returns a paginated list of taxonomy-labels.
Retrieve A Taxonomy-label
Retrieve a taxonomy-label by its ID.
Upload A File
Upload a file in order to reference it as the attachment of another resource (e.g. a portrait).
Retrieve A File
Retrieve a file, either its JSON representation or its content.
List Webhook-endpoints
Returns a paginated list of webhook-endpoints.
Create A Webhook-endpoint
Create a new webhook-endpoint.
Retrieve A Webhook-endpoint
Retrieves a single webhook-endpoint resource.
Update A Webhook-endpoint
Update an existing webhook-endpoint.
Delete A Webhook-endpoint
Delete an existing webhook-endpoint.
List Webhook-deliveries
Returns a paginated list of webhook-deliveries.
Trigger A Test Delivery
Triggers a test delivery to a webhook endpoint to verify it is configured correctly.
Retrieve A Webhook-delivery
Retrieve a webhook-delivery.
List Webhook-delivery-attempts
Retrieve a paginated list of webhook-delivery-attempts.
Retrieve A Webhook-delivery-attempt
Retrieve a webhook-delivery-attempt.
Events
|
12 events
Event
Description
Tags
Employee Created
Processes Lucca employee.created events when a new employee is added.
Employee
Employee Updated
Processes Lucca employee.updated events when an employee is modified.
Employee
Employee Deleted
Processes Lucca employee.deleted events when an employee is removed.
Employee
Employment Created
Processes Lucca employment.created events when a new employment is added.
Employment
Employment Updated
Processes Lucca employment.updated events when an employment is modified.
Employment
Employment Deleted
Processes Lucca employment.deleted events when an employment is removed.
Employment
Job Position Created
Processes Lucca job-position.created events when a new job position is added.
Job Position
Job Position Updated
Processes Lucca job-position.updated events when a job position is modified.
Job Position
Job Position Deleted
Processes Lucca job-position.deleted events when a job position is removed.
Job Position
Employee Extension Created
Processes Lucca employee-extension.created events when a custom attribute value is added.
Employee Attribute
Employee Extension Updated
Processes Lucca employee-extension.updated events when a custom attribute value is modified.
Employee Attribute
Employee Extension Deleted
Processes Lucca employee-extension.deleted events when a custom attribute value is removed.
Employee Attribute

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/lucca/filled/png

Connector Profile

Lucca - OAuth 2.0
https://stackone-logos.com/api/lucca/filled/png

Connector Profile

Lucca - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/lucca/filled/png

Link Account

Lucca - OAuth 2.0
https://stackone-logos.com/api/lucca/filled/png

Link Account

Lucca - API Key
4

Use Actions

Invoke actions using one of the methods below: