Documentation

Files

Organization Structure API

Core HR API

Recruitment API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

List leaves

curl --request GET \
  --url https://{host}/api/v3/leaves \
  --header 'Authorization: <authorization>'

{
  "data": {
    "items": [
      {
        "id": "<string>",
        "date": "2023-12-25",
        "isAm": true,
        "leaveAccountId": 123,
        "leavePeriodId": 123,
        "leaveAccount": {
          "id": 123,
          "name": "<string>"
        },
        "leavePeriod": {
          "id": 123,
          "ownerId": 123,
          "isConfirmed": true,
          "confirmationDate": "2023-11-07T05:31:56Z",
          "attachmentId": "<string>",
          "leaves": [
            {}
          ],
          "logs": [
            {
              "id": 123,
              "date": "2023-11-07T05:31:56Z",
              "comment": "<string>"
            }
          ]
        },
        "value": "<string>",
        "creationDate": "2023-11-07T05:31:56Z",
        "isActive": true,
        "cancellationDate": "2023-11-07T05:31:56Z",
        "cancellationUserId": null,
        "comment": "<string>"
      }
    ]
  }
}

Leaves

List leaves

Retrieve a list of approved leaves for one or several users on a given period.

You MUST filter out results both on a date-range as well as a set of employees through the following query parameters.

In regards to employees filtering, you may:

either retrieve Leaves of a set of specific employees: ?leavePeriod.ownerId=5,6,7
or retrieve Leaves of employees working in a set of specific departments: ?leavePeriod.owner.departmentId=3,4,5
or retrieve Leaves of employees working in a set of specific establishments: ?leavePeriod.owner.legalEntityId=1,2,3

The date query parameter can operate comparisons with a given date value:

?date=2021-01-01: strict equality.
?date=since,2021-01-01: greater than or equal.
?date=until,2021-01-01: lower than or equal.
?date=between,2021-01-01,2021-01-31: comprised between two dates.

GET

api

leaves

List leaves

curl --request GET \
  --url https://{host}/api/v3/leaves \
  --header 'Authorization: <authorization>'

{
  "data": {
    "items": [
      {
        "id": "<string>",
        "date": "2023-12-25",
        "isAm": true,
        "leaveAccountId": 123,
        "leavePeriodId": 123,
        "leaveAccount": {
          "id": 123,
          "name": "<string>"
        },
        "leavePeriod": {
          "id": 123,
          "ownerId": 123,
          "isConfirmed": true,
          "confirmationDate": "2023-11-07T05:31:56Z",
          "attachmentId": "<string>",
          "leaves": [
            {}
          ],
          "logs": [
            {
              "id": 123,
              "date": "2023-11-07T05:31:56Z",
              "comment": "<string>"
            }
          ]
        },
        "value": "<string>",
        "creationDate": "2023-11-07T05:31:56Z",
        "isActive": true,
        "cancellationDate": "2023-11-07T05:31:56Z",
        "cancellationUserId": null,
        "comment": "<string>"
      }
    ]
  }
}

Headers

Authorization

string

required

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

Query Parameters

paging

string

required

{offset},{limit}. Defaults to 0,1000.

Example:

"2000,500"

leaveAccountId

integer[]

ID of the leave-account the leave must have been taken on.

Required range: x >= 1

date

string

required

{comparator},{date-time}

Examples:

"2021-01-01"

"since,2021-01-01"

"until,2021-01-01"

"between,2021-01-01,2021-01-31"

leavePeriod.ownerId

integer[]

Employee's identifier

Required range: x >= 1

leavePeriod.owner.departmentId

integer[]

Employees department identifier

Required range: x >= 1

leavePeriod.owner.legalEntityId

integer[]

Employees establishment (i.e. legal-entity) identifier

Required range: x >= 1

Response

data

object

Show child attributes

The leave-account resource

Get a leave by id