Headers
API key. Value must be formatted like so: lucca application={api_key}.
Path Parameters
ID of the user.
Query Parameters
Comma-separated list of fields of the user to include in responses. Extended data can be retrieved with ?fields=extendedData.
Body
Employee's first name (given name).
1Employee's last name (family name).
1Unique identifier of this employee.
1Employee's professional email address.
1First day of employment.
Establishment this employee works for.
x >= 1Employee number. Must be unique by establishment (i.e. legalEntity).
1Identifier of the department this employee works in.
x >= 1Identifier this user/employee's manager. Is also a user/employee. Null may be interpreted as "this employee has no manager but themselves".
Birth date of this employee.
Language code identifiers (LCID).
1025 <= x <= 583801036
1033
1031
1034
Unique identifier of this employee's business-holidays calendar.
x >= 1Identifier 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.
x >= 1List of "secondary" (complementary) roles given to this user/employee.
Last day of employment. Leave null if unknown.
Identifier of the socio-professional category of this employee.
x >= 1ISO 3166-1 alpha-2 country code
2"FR"
"UK"
"US"
"ES"
"IT"
"DE"
Seniority date of this employee. If left null, you may fall back on this employee's dtContractStart.
Social security number of this employee.
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.
Profile picture of this user/employee.
Personal address of this user/employee.
Professional landline phone number of this user/employee.
Job title of this user/employee.
1Employee declared gender.
Undefined, Male, Female, Misc Personal email address of this user/employee.
Personal mobile phone number of this user/employee.
Professional mobile phone number of this user/employee.
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.
Optional personal quote of this user/employee. Reflects their mood and/or character. Displayed in the "who's who".
Personal credit card number. Only when Lucca Expenses is installed.
Coporate credit card number. Only when Lucca Expenses is installed.
Name of bank of this user/employee bank account.
Employee personal bank account RIB (French: "Relevé d'identité Bancaire").
Employee personal bank account IBAN (International Bank Account Number).
Employee personal bank account SWIFT BIC code (routing number).
Number of fiscal horspowers of the employee car in the context of mileage-related expense claims. Only when Lucca Expenses is installed.
Number of fiscal horspowers of the employee motorcycle in the context of mileage-related expense claims. Only when Lucca Expenses is installed.
Legacy property. Should not be used.
Timestamp of the last time this user/employees attributes were modified.
1Leave accrual profile in Lucca Absences
Full-time equivalent ratio in Lucca Compensation.
Theoretical compensation in Lucca Compensation.
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.
Response
OK
{
"id": 416,
"name": "John Doe",
"url": "http://example.ilucca.net/api/users/1",
"displayName": "Doe John",
"modifiedAt": "2015-09-07T10:20:06.583",
"lastName": "DOE",
"firstName": "John",
"login": "jdoe",
"mail": "no-reply@lucca.fr",
"dtContractStart": "2014-09-01T00:00:00",
"dtContractEnd": null,
"birthDate": "1989-12-22T00:00:00",
"employeeNumber": "00057",
"calendarId": 1,
"calendar": {
"id": 1,
"url": "http://example.ilucca.net/api/v3/publicHolidayCalendars/1",
"name": "Jours fériés en France"
},
"cultureID": 1036,
"culture": {
"id": 1036,
"name": "français (France)",
"url": "http://example.ilucca.net/api/v3/cultures/1036"
},
"picture": {
"id": "74d381db-dd4d-4f64-bc1e-582d806e58a8",
"url": "http://example.ilucca.net/api/v3/files/74d381db-dd4d-4f64-bc1e-582d806e58a8",
"name": "jdoe.png"
},
"legalEntityId": 1,
"legalEntity": {
"id": 1,
"name": "Lucca",
"url": "http://example.ilucca.net/api/v3/legalEntities/1"
},
"departmentId": 13,
"department": {
"id": 13,
"name": "BU Timmi/Lucca",
"url": "http://example.ilucca.net/api/v3/departments/13"
},
"managerId": 383,
"manager": {
"id": 383,
"name": "Roger Smith",
"url": "http://example.ilucca.net/api/v3/users/383"
},
"rolePrincipalId": 55,
"rolePrincipal": {
"id": 55,
"name": "User",
"url": "http://example.ilucca.net/api/v3/roles/55"
},
"habilitedRoles": [
{
"id": 59,
"name": "Employee +",
"url": "http://example.ilucca.net/api/v3/roles/59"
},
{
"id": 63,
"name": "Analytics access",
"url": "http://example.ilucca.net/api/roles/63"
}
],
"userWorkCycles": [
{
"id": 288,
"ownerID": 416,
"workCycleID": 6,
"startsOn": "1900-01-01T00:00:00",
"endsOn": "2015-03-09T00:00:00"
},
{
"id": 289,
"ownerID": 416,
"workCycleID": 9,
"startsOn": "2015-03-10T00:00:00",
"endsOn": "2015-10-13T00:00:00"
},
{
"id": 317,
"ownerID": 416,
"workCycleID": 14,
"startsOn": "2015-10-13T00:00:00",
"endsOn": "9999-12-31T00:00:00"
}
],
"allowsElectronicPayslip": true,
"userAxisValues_2": { "id": 35 }
}