GET
/
lucca-api
/
employee-personal-records
curl --request GET \
  --url https://{host}/lucca-api/employee-personal-records \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "type": "employee-personal-records",
  "url": "https://example.ilucca.net/lucca-api/employee-personal-records?page=qsdkuh&limit=1",
  "items": [
    {
      "id": "897",
      "type": "employee-personal-record",
      "url": "https://example.ilucca.net/lucca-api/employee-personal-records/897",
      "employee": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416"
      },
      "title": "mister",
      "legalGender": "male",
      "birthDate": "1989-12-21",
      "insuranceNumber": {
        "format": "frenchSSN",
        "value": "1760774865895 37"
      },
      "nationalitiesCountryCodes": [
        "FRA"
      ],
      "bankAccount": {
        "format": "iban",
        "iban": "FR8817569000503595615775H03",
        "bic": "PSSTFRPPXXX"
      },
      "phoneNumber": "+33456789634",
      "email": "jdoe13@gmail.com",
      "links": null
    }
  ],
  "totalCount": 203,
  "embedded": {
    "employee": {
      "416": {
        "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"
          }
        }
      }
    }
  },
  "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
Examples:

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

Examples:

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

Examples:

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

Read more about expanding responses.

​
page
string

Cursor of the page to retrieve. Read more about pagination.

​
limit
integer
default:25

Number of items per page. Defaults to 25. Maximum is 100. Read more about pagination.

Required range: 0 <= x <= 100
​
employee.id
string[]

Filter out personal-records on the employee IDs.

Maximum length: 100
Examples:
["123", "456"]
​
legalGender
enum<string>[]

Filter out personal-records on the employee legal gender.

Maximum length: 100
Examples:
["male", "female"]
​
nationalitiesCountryCodes
enum<string>[]

Only return employees who have at least one of the passed country codes nationalities.

Maximum length: 100
Examples:
["FRA", "DEU"]

Response

200
application/json

OK

An collection of employee-personal-record resources. Links on a collection. Embedded resources on a employee-personal-record(s) response. A collection of employee-personal-record objects.