Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
Users

Create a new User

Create a new user

post/api/v3/users

Query parameters

fieldsstring

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

Request body

idnumber

Unique identifier

urlstring uri
firstNamestring required

Employee's first name (given name).

lastNamestring required

Employee's last name (family name).

namestring

Concatenation of both the firstName and lastName

displayNamestring

Concatenation of both the lastName and firstName.

loginstring required

Unique identifier of this employee.

mailstring required

Employee's professional email address.

dtContractStartstring date-time required

First day of employment.

dtContractEndstring date-time nullable

Last day of employment. Leave null if unknown.

legalEntityIdinteger required

Establishment this employee works for.

employeeNumberstring nullable required

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

departmentIdinteger required

Identifier of the department this employee works in.

managerIdinteger nullable required

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

cspIdinteger nullable

Identifier of the socio-professional category of this employee.

nationalityIdstring nullable

ISO 3166-1 alpha-2 country code

seniorityDatestring date-time nullable

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

birthDatestring date-time nullable required

Birth date of this employee.

insuranceNumberstring nullable

Social security number of this employee.

cultureIDinteger required

Language code identifiers (LCID).

calendarIdinteger nullable required

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

rolePrincipalIdinteger 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.

addressstring nullable

Personal address of this user/employee.

directLinestring phone nullable

Professional landline phone number of this user/employee.

jobTitlestring nullable

Job title of this user/employee.

gender'Undefined' | 'Male' | 'Female' | 'Misc'

Employee declared gender.

personalEmailstring email nullable

Personal email address of this user/employee.

personalMobilestring phone nullable

Personal mobile phone number of this user/employee.

professionalMobilestring phone nullable

Professional mobile phone number of this user/employee.

allowsElectronicPayslipboolean nullable

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.

quotestring nullable

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

personalCardstring nullable

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

corporateCardstring nullable

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

bankNamestring nullable

Name of bank of this user/employee bank account.

ribstring nullable

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

ibanstring nullable

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

bicstring nullable

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

frenchCarTaxHorsePowerinteger nullable

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

frenchMotocyclesTaxHorsePowerinteger nullable

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

unitSellPricenumber double nullable

Legacy property. Should not be used.

modifiedAtstring date-time

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

manager2Idinteger nullable

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.

Example request

{
  "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
}

Response

OK

Example response

{
  "data": {
    "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
    }
  }
}