List employees

GET

lucca-api

employees

Copy
curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/lucca-api/employees \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

Copy
{
  "type": "employees",
  "url": "https://example.ilucca.net/lucca-api/employees?limit=10",
  "totalCount": 647,
  "items": [
    {
      "id": "416",
      "type": "employee",
      "url": "https://example.ilucca.net/lucca-api/employees/416",
      "remoteId": "00002345",
      "portrait": {
        "id": "66512232",
        "type": "portrait",
        "url": "https://example.ilucca.net/lucca-api/portraits/66512232"
      },
      "givenName": "Edward",
      "familyName": "Atkinson",
      "employeeNumber": "E000124",
      "status": "active",
      "email": "eatkinson@acme.corp",
      "birthDay": {
        "day": 22,
        "month": 12
      },
      "phoneNumber": "+33145784512",
      "applicableEmployment": {
        "id": "154",
        "type": "employment",
        "url": "https://example.ilucca.net/lucca-api/employments/154"
      },
      "applicableJobPosition": {
        "id": "74",
        "type": "job-position",
        "url": "https://example.ilucca.net/lucca-api/job-positions/74"
      },
      "createdAt": "2024-04-15T23:12:54.0001Z",
      "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
      "links": {
        "employments": {
          "href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
        },
        "jobPositions": {
          "href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
        },
        "personalRecord": {
          "href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
        }
      }
    }
  ],
  "embedded": {
    "employment": {
      "4561": {
        "id": "4561",
        "type": "employment",
        "url": "https://example.ilucca.net/lucca-api/employments/4561",
        "remoteId": "EMPLOYMENT#4512-ac",
        "employee": {
          "id": "416",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/416"
        },
        "legalEntity": {
          "id": "123",
          "type": "legal-entity",
          "url": "https://example.ilucca.net/lucca-api/legal-entities/123"
        },
        "start": {
          "date": "2024-01-01"
        },
        "end": null,
        "document": {
          "id": "74411",
          "type": "file",
          "url": "https://example.ilucca.net/lucca-api/files/74411"
        },
        "template": {
          "id": "4",
          "type": "employment-template",
          "url": "https://example.ilucca.net/lucca-api/employment-templates/4"
        },
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {
          "jobPositions": {
            "href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
          },
          "trialPeriods": {
            "href": "https://example.ilucca.net/lucca-api/trial-periods?employment.id=4561"
          }
        }
      }
    },
    "job-position": {
      "74": {
        "id": "74",
        "type": "job-position",
        "url": "https://example.ilucca.net/lucca-api/job-positions/74",
        "remoteId": null,
        "employment": {
          "id": "28",
          "type": "employment",
          "url": "https://example.ilucca.net/lucca-api/employments/28"
        },
        "employee": {
          "id": "416",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/416"
        },
        "startsOn": "2024-01-01",
        "endsOn": null,
        "businessEstablishment": {
          "id": "5",
          "type": "business-establishment",
          "url": "https://example.ilucca.net/lucca-api/business-establishments/5"
        },
        "jobTitle": "Developer",
        "jobQualification": {
          "id": "982",
          "type": "job-qualification",
          "url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
        },
        "manager": {
          "id": "541",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/541"
        },
        "occupationCategory": {
          "id": "12",
          "type": "occupation-category",
          "url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
        },
        "workingTimeArrangement": {
          "id": "23",
          "type": "working-time-arrangement",
          "url": "about:blank"
        },
        "department": {
          "id": "32",
          "type": "department",
          "url": "https://example.ilucca.net/lucca-api/departments/32"
        },
        "document": null,
        "notes": null,
        "changedAttributes": [
          "jobTitle",
          "jobDescription",
          "jobQualification"
        ],
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": null
      }
    }
  },
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}

Authorizations

Authorization

string

header

required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

Api-Version

enum<string>

required

Set the API version.

Available options:

2024-11-01

Example:

"2024-11-01"

If-None-Match

string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match

string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding

string

List of compression algorithms you support.

Query Parameters

include

enum<string>[]

Include metadata:

embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Response

200

application/json

A collection of employee resources.

type

string

required

Allowed value: "employees"

url

string

required

items

object[]

required

Paginated list of employee resources.

The employee represents the public face of an employee in the system. Note that an employee can also represent a trainee, an intern, a contractor, etc...

The applicableEmployment property references the employee's employment that is:

currently in effect if the employee is "active".
will first be in effect if the employee has an employment starting in the future (either the first or a new one).
was last in effect if the employee is no longer employed and is not expected to be re-remployed in the future.

The applicableJobPosition property references the employee's job-position that matches the same logic.

items.id

string

required

Minimum length: 1

items.type

string

required

Allowed value: "employee"

items.url

string

required

items.givenName

string

required

Name given at birth. In the U.S.A., the first name of a person. In French: "prénom". Leading and trailing spaces are automatically removed.

Required string length: 1 - 100

items.familyName

string

required

Name inherited from the person's family. In the U.S.A., the last name of a person. In French: "nom (de famille)". Leading and trailing spaces are automatically removed.

Required string length: 1 - 100

items.email

string | null

required

Professional email of this employee. "<" and ">" characters are forbidden. Some domains are blacklisted and may thus result in 400 errors.

Required string length: 3 - 255

items.remoteId

string | null

Must be unique.

Required string length: 1 - 100

items.portrait

object | null

Reference to the employee's portrait, which is a file (picture) representing them.

Example:

{
  "id": "9283sdf",
  "type": "portrait",
  "url": "https://example.ilucca.net/lucca-api/portraits/9283sdf"
}

items.employeeNumber

string | null

Minimum length: 1

items.status

enum<string>

Read-only. The employee status is calculated from the employee's employments.

active: employee has an employment as of today.
upcoming: employee currently has no employment but will have one in the future.
deactivated: employee used to have an employment but no longer does.

Available options:

active,

upcoming,

deactivated

Example:

"active"

items.birthDay

object | null

Year-less date of birth.

Read-only, as it is infered from the employee-personal-record birthDate. Take note that month starts at "1" and not zero, i.e. "1" is for January, "2" for February, etc...

items.phoneNumber

string | null

Professional phone number of this employee.

Example:

"+3356565656"

items.applicableEmployment

object

Read-only. Reference to the applicable employment of this employee. If the employee status is "deactivated", then references their last employment. If the employee status is "upcoming", then references their closest next employment.

items.applicableJobPosition

object

Read-only. Reference to the active job-position of this employee. Matches the same logic than the "applicableEmployment".

items.createdAt

string

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

items.lastUpdatedAt

string

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Example:

"2023-01-23T12:45:23.1234Z"

items.links

object

totalCount

integer | null

Total number of employee resources across all pages that satisfy query parameters.

Required range: x >= 0

embedded

object | null

embedded.employment

object | null

Dictionary of employments indexed by ID.

embedded.employment.{key}

object

The employment resource represents a relationship between an employee and a legal-entity over a continuous period. It may actually represent a work contract, an internship agreement, a contractor's contract, etc...

The actual job of the employee is defined through the job-position resource, which references an employment. Over the course of his/her employment, the employee may occupy several job-positions.

embedded.employment.{key}.id

string

required

Minimum length: 1

embedded.employment.{key}.type

string

required

Allowed value: "employment"

embedded.employment.{key}.url

string

required

embedded.employment.{key}.start

object

required

embedded.employment.{key}.template

object

required

Reference to an employment-template resource.

Example:

{
  "id": "857",
  "type": "employment-template",
  "url": "https://example.ilucca.net/lucca-api/employment-templates/857"
}

embedded.employment.{key}.remoteId

string | null

Resource identifier in a third-party system.

Required string length: 1 - 200

embedded.employment.{key}.employee

object

Reference to an employee resource.

Example:

{
  "id": "416",
  "type": "employee",
  "url": "https://example.ilucca.net/lucca-api/employees/416"
}

embedded.employment.{key}.legalEntity

object

Read-only. Reference to a legal-entity. Inferred from the business-establishment of its first job-position.

Example:

{
  "id": "123",
  "type": "legal-entity",
  "url": "https://example.ilucca.net/lucca-api/legal-entities/123"
}

embedded.employment.{key}.end

object | null

embedded.employment.{key}.document

object | null

Reference to a file resource.

Example:

{
  "id": "9283sdf",
  "type": "file",
  "url": "https://example.ilucca.net/lucca-api/files/9283sdf"
}

embedded.employment.{key}.createdAt

string

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

embedded.employment.{key}.lastUpdatedAt

string

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Example:

"2023-01-23T12:45:23.1234Z"

embedded.employment.{key}.links

object | null

Example:

{
  "id": "4561",
  "type": "employment",
  "url": "https://example.ilucca.net/lucca-api/employments/4561",
  "remoteId": "EMPLOYMENT#4512-ac",
  "employee": {
    "id": "416",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/416"
  },
  "legalEntity": {
    "id": "123",
    "type": "legal-entity",
    "url": "https://example.ilucca.net/lucca-api/legal-entities/123"
  },
  "start": { "date": "2024-01-01" },
  "end": null,
  "document": {
    "id": "74411",
    "type": "file",
    "url": "https://example.ilucca.net/lucca-api/files/74411"
  },
  "template": {
    "id": "4",
    "type": "employment-template",
    "url": "https://example.ilucca.net/lucca-api/employment-templates/4"
  },
  "createdAt": "2024-04-15T23:12:54.0001Z",
  "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
  "links": {
    "jobPositions": {
      "href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
    },
    "trialPeriods": {
      "href": "https://example.ilucca.net/lucca-api/trial-periods?employment.id=4561"
    }
  }
}

embedded.job-position

object | null

Dictionary of job-positions indexed by ID.

embedded.job-position.{key}

object

The job position represents a stage in an employee's career during one of their employment in a given business-establishment.

It therefore outlines the attributes of the person as a professional (qualifications) and their role in the company as well as who's their manager.

embedded.job-position.{key}.id

string

required

Minimum length: 1

embedded.job-position.{key}.type

string

required

Allowed value: "job-position"

embedded.job-position.{key}.url

string

required

embedded.job-position.{key}.employment

object

required

Reference to an employment resource.

Example:

{
  "id": "354",
  "type": "employment",
  "url": "https://example.ilucca.net/lucca-api/employments/354"
}

embedded.job-position.{key}.startsOn

string

required

Effective date of this job-position for this employee.

Cannot be outside the range of the employment.

This should be considered "applicable" based on the related employment business-establishment timezone.

embedded.job-position.{key}.businessEstablishment

object

required

Reference to a business-establishment resource.

Example:

{
  "id": "5",
  "type": "business-establishment",
  "url": "https://example.ilucca.net/lucca-api/business-establishments/5"
}

embedded.job-position.{key}.department

object

required

Reference to a department.

Example:

{
  "id": "32",
  "type": "department",
  "url": "https://example.ilucca.net/lucca-api/departments/32"
}

embedded.job-position.{key}.remoteId

string | null

Resource identifier in a third-party system. No unicity constraint: two job-positions may have the same value.

embedded.job-position.{key}.employee

object

Read-only. Reference to the employment's employee.

embedded.job-position.{key}.endsOn

string | null

Read-only. End date (included) of this job-position effectiveness.

Is calculated from the startsOn property of the closest next job-position, or the endsOn date of the parent employment.

This should be considered "applicable" based on the related employment business-establishment timezone.

Must be greater or equal than StartsOn date.

embedded.job-position.{key}.jobTitle

string | null

Short description of the job occupied by this employee.

Maximum length: 250

embedded.job-position.{key}.jobQualification

object | null

Reference to a job-qualification.

Example:

{
  "id": "982",
  "type": "job-qualification",
  "url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
}

embedded.job-position.{key}.manager

object | null

Reference to another employee, who is considered to be this employee's manager.

Example:

{
  "id": "416",
  "type": "employee",
  "url": "https://example.ilucca.net/lucca-api/employees/416"
}

embedded.job-position.{key}.occupationCategory

object | null

Reference to an occupation-category.

Example:

{
  "id": "443",
  "type": "occupation-category",
  "url": "https://example.ilucca.net/lucca-api/occupation-category/443"
}

embedded.job-position.{key}.workingTimeArrangement

object | null

Reference to a working-time-arrangement.

Example:

{
  "id": "98",
  "type": "working-time-arrangement",
  "url": "about:blank"
}

embedded.job-position.{key}.document

object | null

Reference to a document resource.

Example:

{
  "id": "95",
  "type": "document",
  "url": "https://example.ilucca.net/lucca-api/documents/95"
}

embedded.job-position.{key}.notes

string | null

Optional notes about this job-position change.

Maximum length: 500

embedded.job-position.{key}.changedAttributes

enum<string>[]

List of attributes that changed compared with this employee previous job-position, even if said job-position was on another employment and/or not immediately sequential.

List of attributes that can change for a job-position.

Available options:

remoteId,

jobTitle,

jobDescription,

jobQualification,

occupationCategory,

workingTimeArrangement,

department

embedded.job-position.{key}.t9n

object

embedded.job-position.{key}.createdAt

string

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

embedded.job-position.{key}.lastUpdatedAt

string

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Example:

"2023-01-23T12:45:23.1234Z"

embedded.job-position.{key}.links

null

Example:

{
  "id": "74",
  "type": "job-position",
  "url": "https://example.ilucca.net/lucca-api/job-positions/74",
  "remoteId": null,
  "employment": {
    "id": "28",
    "type": "employment",
    "url": "https://example.ilucca.net/lucca-api/employments/28"
  },
  "employee": {
    "id": "416",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/416"
  },
  "startsOn": "2024-01-01",
  "endsOn": null,
  "businessEstablishment": {
    "id": "5",
    "type": "business-establishment",
    "url": "https://example.ilucca.net/lucca-api/business-establishments/5"
  },
  "jobTitle": "Developer",
  "jobQualification": {
    "id": "982",
    "type": "job-qualification",
    "url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
  },
  "manager": {
    "id": "541",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/541"
  },
  "occupationCategory": {
    "id": "12",
    "type": "occupation-category",
    "url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
  },
  "workingTimeArrangement": {
    "id": "23",
    "type": "working-time-arrangement",
    "url": "about:blank"
  },
  "department": {
    "id": "32",
    "type": "department",
    "url": "https://example.ilucca.net/lucca-api/departments/32"
  },
  "document": null,
  "notes": null,
  "changedAttributes": [
    "jobTitle",
    "jobDescription",
    "jobQualification"
  ],
  "createdAt": "2024-04-15T23:12:54.0001Z",
  "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
  "links": null
}

links

object | null

Links to related resources

Was this page helpful?

The employee resource

Retrieve an employee

Copy
curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/lucca-api/employees \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

Copy
{
  "type": "employees",
  "url": "https://example.ilucca.net/lucca-api/employees?limit=10",
  "totalCount": 647,
  "items": [
    {
      "id": "416",
      "type": "employee",
      "url": "https://example.ilucca.net/lucca-api/employees/416",
      "remoteId": "00002345",
      "portrait": {
        "id": "66512232",
        "type": "portrait",
        "url": "https://example.ilucca.net/lucca-api/portraits/66512232"
      },
      "givenName": "Edward",
      "familyName": "Atkinson",
      "employeeNumber": "E000124",
      "status": "active",
      "email": "eatkinson@acme.corp",
      "birthDay": {
        "day": 22,
        "month": 12
      },
      "phoneNumber": "+33145784512",
      "applicableEmployment": {
        "id": "154",
        "type": "employment",
        "url": "https://example.ilucca.net/lucca-api/employments/154"
      },
      "applicableJobPosition": {
        "id": "74",
        "type": "job-position",
        "url": "https://example.ilucca.net/lucca-api/job-positions/74"
      },
      "createdAt": "2024-04-15T23:12:54.0001Z",
      "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
      "links": {
        "employments": {
          "href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
        },
        "jobPositions": {
          "href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
        },
        "personalRecord": {
          "href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
        }
      }
    }
  ],
  "embedded": {
    "employment": {
      "4561": {
        "id": "4561",
        "type": "employment",
        "url": "https://example.ilucca.net/lucca-api/employments/4561",
        "remoteId": "EMPLOYMENT#4512-ac",
        "employee": {
          "id": "416",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/416"
        },
        "legalEntity": {
          "id": "123",
          "type": "legal-entity",
          "url": "https://example.ilucca.net/lucca-api/legal-entities/123"
        },
        "start": {
          "date": "2024-01-01"
        },
        "end": null,
        "document": {
          "id": "74411",
          "type": "file",
          "url": "https://example.ilucca.net/lucca-api/files/74411"
        },
        "template": {
          "id": "4",
          "type": "employment-template",
          "url": "https://example.ilucca.net/lucca-api/employment-templates/4"
        },
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {
          "jobPositions": {
            "href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
          },
          "trialPeriods": {
            "href": "https://example.ilucca.net/lucca-api/trial-periods?employment.id=4561"
          }
        }
      }
    },
    "job-position": {
      "74": {
        "id": "74",
        "type": "job-position",
        "url": "https://example.ilucca.net/lucca-api/job-positions/74",
        "remoteId": null,
        "employment": {
          "id": "28",
          "type": "employment",
          "url": "https://example.ilucca.net/lucca-api/employments/28"
        },
        "employee": {
          "id": "416",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/416"
        },
        "startsOn": "2024-01-01",
        "endsOn": null,
        "businessEstablishment": {
          "id": "5",
          "type": "business-establishment",
          "url": "https://example.ilucca.net/lucca-api/business-establishments/5"
        },
        "jobTitle": "Developer",
        "jobQualification": {
          "id": "982",
          "type": "job-qualification",
          "url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
        },
        "manager": {
          "id": "541",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/541"
        },
        "occupationCategory": {
          "id": "12",
          "type": "occupation-category",
          "url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
        },
        "workingTimeArrangement": {
          "id": "23",
          "type": "working-time-arrangement",
          "url": "about:blank"
        },
        "department": {
          "id": "32",
          "type": "department",
          "url": "https://example.ilucca.net/lucca-api/departments/32"
        },
        "document": null,
        "notes": null,
        "changedAttributes": [
          "jobTitle",
          "jobDescription",
          "jobQualification"
        ],
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": null
      }
    }
  },
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}

Overview

Organization

Employee Records

Authorizations

Headers

Query Parameters

Response