Users

Lucca Users API

Sync permissioned users data with Lucca through Apideck's unified API. One integration, instant access to the governed data your team needs.

In Apideck, this resource is called Employees (API: employees)

Supported Operations for Lucca Users

List, Get operations available through our unified API

list

get

create

update

delete

Supported Fields

26 fields

Fields available for Lucca Users

idfirst_namelast_namedisplay_namepreferred_nametitledepartmentdepartment_iddepartment_namecompany_idcompany_nameemployment_start_dateemployment_end_dateemployee_numberemployment_status+11 more

API Model Preview

Sample response structure for users

{
  "id": "12345",
  "first_name": "Example First Name",
  "last_name": "Example Last Name",
  "display_name": "Example Display Name",
  "preferred_name": "Example Preferred Name",
  "title": "Example Title",
  "department": "string",
  "department_id": "12345",
  "department_name": "Example Department Name",
  "company_id": "12345",
  "company_name": "Example Company Name",
  "employment_start_date": "2024-01-15",
  "employment_end_date": "2024-01-15",
  "employee_number": 10,
  "employment_sta
  ...

Quick Start Example

Start syncing Lucca users in minutes

Node.js

import { Apideck } from '@apideck/unify'

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: 'YOUR_APP_ID',
  consumerId: 'YOUR_CONSUMER_ID'
})

// List users from Lucca
const result = await apideck.hris.employees.list({
  serviceId: 'lucca-hr'
})

for await (const page of result) {
  console.log(page)
}
// Returns unified users data

View full SDK documentation

Popular Use Cases