List Users

Headers

Authorization

string

required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

integer[]

User's identifier.

Required range: x >= 1

dtContractStart

string

Format: ({comparator},)?{date}.

dtContractEnd

string | null

Format: ({comparator},)?{date | 'null'}.

modifiedAt

string

Only return users/employees who have been modified since {date}.

Format: '{comparator},{date-time}'

Example:

"since,2025-01-01T08:45:23"

paging

string

default:0,1000

Format: {offset},{limit}, where:

offset: index of the first item to retrieve in the collection.
limit: maximum number of items to retrieve.

Maximum limit is "1000".'

fields

string

Comma-separated list of fields of the user to include in responses. Extended data can be retrieved with ?fields=extendedData.

mail

string

User's mail (strict equality). You may prefix with the like, operator in order to execute a LIKE search (e.g.: ?mail=like,jdoe).

User's login (strict equality).

formerEmployees

boolean

default:false

Whether former (terminated) employees should be included in response ?formerEmployees=true along active employees. They are excluded by default. Please note that you may not be able to retrieve former employees even when including them, depending on your access rights.

Response

data

object

Show child attributes

data.items

User (v3) · object[]

Show child attributes

data.items.firstName

string

required

Employee's first name (given name).

Minimum string length: 1

data.items.lastName

string

required

Employee's last name (family name).

Minimum string length: 1

Unique identifier of this employee.

Minimum string length: 1

data.items.mail

string

required

Employee's professional email address.

Minimum string length: 1

data.items.dtContractStart

string<date-time>

required

First day of employment.

data.items.legalEntityId

integer

required

Establishment this employee works for.

Required range: x >= 1

data.items.employeeNumber

string | null

required

Employee number. Must be unique by establishment (i.e. legalEntity).

Minimum string length: 1

data.items.departmentId

integer

required

Identifier of the department this employee works in.

Required range: x >= 1

data.items.managerId

integer | null

required

Identifier this user/employee's manager. Is also a user/employee. Null may be interpreted as "this employee has no manager but themselves".

data.items.birthDate

string<date-time> | null

required

Birth date of this employee.

data.items.cultureID

integer

required

Language code identifiers (LCID).

Required range: 1025 <= x <= 58380

data.items.calendarId

integer | null

required

Unique identifier of this employee's business-holidays calendar.

Required range: x >= 1

data.items.rolePrincipalId

integer

required

Identifier of the "primary" role this user/employee has.

There are two types of roles: "primary" and "secondary". A user/employee must have a single primary role, that dictates their overall level of access, as well as zero or several complementary "secondary" roles.

Required range: x >= 1

data.items.habilitedRoles

object[]

required

List of "secondary" (complementary) roles given to this user/employee.

Show child attributes

data.items.habilitedRoles.id

integer

required

Required range: x >= 1

data.items.habilitedRoles.name

string

Minimum string length: 1

data.items.habilitedRoles.url

string

Minimum string length: 1

data.items.id

number

Unique identifier

Required range: x >= 1

data.items.url

string<uri>

Minimum string length: 1

data.items.name

string

Concatenation of both the firstName and lastName

Minimum string length: 1

data.items.displayName

string

Concatenation of both the lastName and firstName.

Minimum string length: 1

data.items.dtContractEnd

string<date-time> | null

Last day of employment. Leave null if unknown.

data.items.legalEntity

object

Embedded representation of the establishment this employee works for.

Show child attributes

data.items.legalEntity.id

integer

Required range: x >= 1

data.items.legalEntity.name

string

data.items.legalEntity.url

string<uri>

data.items.department

object

Embedded representation of the department. Read more about departments.

Show child attributes

data.items.department.id

integer

Identifier of the department this user/employee works in.

Required range: x >= 1

data.items.department.name

string

Name of the department this user/employee works in.

Minimum string length: 1

data.items.department.url

string<uri>

URL of the department resource.

data.items.manager

object

Show child attributes

data.items.manager.id

integer

Identifier this user/employee's manager. Is also a user/employee.

Required range: x >= 1

data.items.manager.firstName

string

The manager's first name.

Minimum string length: 1

data.items.manager.lastName

string

The manager's last name.

Minimum string length: 1

data.items.manager.url

string<uri>

data.items.cspId

integer | null

Identifier of the socio-professional category of this employee.

Required range: x >= 1

data.items.nationalityId

string | null

ISO 3166-1 alpha-2 country code

Required string length: 2

data.items.seniorityDate

string<date-time> | null

Seniority date of this employee. If left null, you may fall back on this employee's dtContractStart.

data.items.insuranceNumber

string | null

Social security number of this employee.

data.items.calendar

object

Show child attributes

data.items.calendar.id

integer

required

Unique identifier of the business-holidays calendar that applies to this user/employee.

Required range: x >= 1

data.items.calendar.url

string

Minimum string length: 1

data.items.calendar.name

string

Minimum string length: 1

data.items.userWorkCycles

object[]

Work-cycles describe the expected (recurring) working hours of the employee. An employee may be given multiple work-cycles over their career, but no two may overlap.

Show child attributes

data.items.userWorkCycles.workCycleID

integer

required

Identifier of the workcycle.

Required range: x >= 1

data.items.userWorkCycles.startsOn

string<date-time>

required

data.items.userWorkCycles.endsOn

string<date-time> | null

required

data.items.userWorkCycles.id

integer

data.items.userWorkCycles.ownerID

integer

Identifier of the employee.

data.items.userWorkCycles.workCycle

object

Show child attributes

data.items.userWorkCycles.workCycle.id

integer

Required range: x >= 1

data.items.userWorkCycles.workCycle.name

string

data.items.userWorkCycles.workCycle.url

string<uri>

data.items.picture

object

Profile picture of this user/employee.

Show child attributes

data.items.picture.id

string<uuid>

required

Unique identifier of the user/employee's picture file.

data.items.picture.href

string<uri>

Follow this link in order to retrieve the image file.

data.items.rolePrincipal

object

Show child attributes

data.items.rolePrincipal.id

number

required

Identifier of the "primary" role this user/employee has.

data.items.rolePrincipal.name

string

Name of the "primary" role this user/employee has.

Minimum string length: 1

data.items.rolePrincipal.url

string

Minimum string length: 1

data.items.address

string | null

Personal address of this user/employee.

data.items.directLine

string<phone> | null

Professional landline phone number of this user/employee.

data.items.jobTitle

string | null

Job title of this user/employee.

Minimum string length: 1

data.items.gender

enum<string>

default:Undefined

Employee declared gender.

Available options:

Undefined,

Male,

Female,

Misc

data.items.personalEmail

string<email> | null

Personal email address of this user/employee.

data.items.personalMobile

string<phone> | null

Personal mobile phone number of this user/employee.

data.items.professionalMobile

string<phone> | null

Professional mobile phone number of this user/employee.

data.items.allowsElectronicPayslip

boolean | null

Whether this user/employee gave their consent to receive their payslip in an electronic format (i.e. PDF and email) rather than through physical means. This property is used by the Lucca Payslips application.

data.items.quote

string | null

Optional personal quote of this user/employee. Reflects their mood and/or character. Displayed in the "who's who".

data.items.personalCard

string | null

Personal credit card number. Only when Lucca Expenses is installed.

data.items.corporateCard

string | null

Coporate credit card number. Only when Lucca Expenses is installed.

data.items.bankName

string | null

Name of bank of this user/employee bank account.

data.items.rib

string | null

Employee personal bank account RIB (French: "Relevé d'identité Bancaire").

data.items.iban

string | null

Employee personal bank account IBAN (International Bank Account Number).

data.items.bic

string | null

Employee personal bank account SWIFT BIC code (routing number).

data.items.frenchCarTaxHorsePower

integer | null

Number of fiscal horspowers of the employee car in the context of mileage-related expense claims. Only when Lucca Expenses is installed.

data.items.frenchMotocyclesTaxHorsePower

integer | null

Number of fiscal horspowers of the employee motorcycle in the context of mileage-related expense claims. Only when Lucca Expenses is installed.

data.items.unitSellPrice

number<double> | null

Legacy property. Should not be used.

data.items.modifiedAt

string<date-time>

Timestamp of the last time this user/employees attributes were modified.

Minimum string length: 1

data.items.applicationData

object

Show child attributes

data.items.applicationData.profile_figgo

object

Leave accrual profile in Lucca Absences

Show child attributes

data.items.applicationData.profile_figgo.id

integer

Required range: x >= 1

data.items.applicationData.profile_figgo.name

string

data.items.applicationData.profile_figgo.url

string<url>

data.items.applicationData.fullTimeEquivalent

object

Full-time equivalent ratio in Lucca Compensation.

Show child attributes

data.items.applicationData.fullTimeEquivalent.value

string

data.items.applicationData.fullTimeEquivalent.link

object

data.items.applicationData.theoreticalRemuneration

object

Theoretical compensation in Lucca Compensation.

Show child attributes

data.items.applicationData.theoreticalRemuneration.value

string

data.items.applicationData.theoreticalRemuneration.link

object

Show child attributes

data.items.applicationData.theoreticalRemuneration.link.url

string<url>

data.items.applicationData.theoreticalRemuneration.link.text

string

Minimum string length: 1

data.items.applicationData.manager2Id

integer | null

Manager 2 may be used in the Lucca Absences approval workflow (depends on how it is configured).

manager2Id should be used in write requests, and manager2 in read requests in order to retrieve the corresponding user representation.

data.items.applicationData.manager2

object

Show child attributes

data.items.applicationData.manager2.id

integer

Required range: x >= 0

data.items.applicationData.manager2.name

string

Minimum string length: 1

data.items.applicationData.manager2.url

string<uri>

Example:

{
  "profile_figgo": {
    "id": 1,
    "name": "Cadre (218 jours)",
    "url": "https://example.ilucca.net/api/v3/leaveprofiles/1"
  },
  "profile_cleemy_89": {
    "id": 23,
    "name": "Regular employee",
    "url": "https://example.ilucca.net/api/v3/expenseprofiles-89/23"
  },
  "fullTimeEquivalent": { "value": "Full time", "link": null },
  "theoreticalRemuneration": {
    "value": "87,000.00 €",
    "link": {
      "url": "https://example.ilucca.net/popleerem/remunerations#/416",
      "text": "Go to Lucca Compensation"
    }
  },
  "manager2": null
}

data.items.extendedData

object

Dictionary of extended data, which are custom extensions to the base user/employee model. Keys are the custom extended-data definition identifier (e.g. e_Emergency-Contact). The value is polymorphic, and its type depends on the extended-data definition.

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

Headers

Query Parameters

Response