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": "<unknown>",
          "attachmentId": "<unknown>",
          "leaves": [
            {}
          ],
          "logs": [
            {
              "id": 123,
              "date": "2023-11-07T05:31:56Z",
              "comment": "<string>",
              "status": 0
            }
          ]
        },
        "value": "<string>",
        "creationDate": "2023-11-07T05:31:56Z",
        "isActive": true,
        "cancellationDate": "<unknown>",
        "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": "<unknown>",
          "attachmentId": "<unknown>",
          "leaves": [
            {}
          ],
          "logs": [
            {
              "id": 123,
              "date": "2023-11-07T05:31:56Z",
              "comment": "<string>",
              "status": 0
            }
          ]
        },
        "value": "<string>",
        "creationDate": "2023-11-07T05:31:56Z",
        "isActive": true,
        "cancellationDate": "<unknown>",
        "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}

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

data.items

The Leave resource · object[]

Show child attributes

data.items.id

string

required

Unique identifier for the Leave

data.items.date

string<date>

required

Date of the leave in ISO format yyyy-mm-dd

data.items.isAm

boolean

required

Has the value true for morning or the value false for afternoon

data.items.leaveAccountId

integer

required

Unique identifier for the attached LeaveAccount

data.items.leavePeriodId

integer

required

Unique identifier for the attached LeavePeriod

data.items.leaveAccount

The LeaveAccount resource · object

LeaveAccounts are the type of absences that can be selected by the user

Fields

Show child attributes

data.items.leaveAccount.id

integer

Unique identifier for the LeaveAccount

data.items.leaveAccount.name

string

Name of the LeaveAccount

data.items.leavePeriod

The LeavePeriod resource · object

Show child attributes

data.items.leavePeriod.id

number

Unique identifier for the LeavePeriod

data.items.leavePeriod.ownerId

number

Unique identifier for the user

data.items.leavePeriod.isConfirmed

boolean

Has the value true for approved LeavePeriod or the value false for LeavePeriod pending approval

data.items.leavePeriod.confirmationDate

null | string<date-time>

Time at which the LeavePeriod was approved

data.items.leavePeriod.attachmentId

null | string

Unique identifier for the attached document

data.items.leavePeriod.leaves

object[]

data.items.leavePeriod.logs

The LeavePeriodLog resource · object[]

Show child attributes

data.items.leavePeriod.logs.id

integer

data.items.leavePeriod.logs.date

string<date-time>

data.items.leavePeriod.logs.comment

string

data.items.leavePeriod.logs.status

enum<number>

0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING

Available options:

0,

2,

3,

4,

5

data.items.value

string<duration> | null

Leave duration in hours

data.items.creationDate

string<date-time>

Time at which the object was created

data.items.isActive

boolean

Has the value true when the Leave exists (for pending or confirmed LeavePeriods), or the value false when it has been deleted (for canceled or denied LeaveRequests).

data.items.cancellationDate

null | string<date-time>

Time at which the request was canceled

data.items.cancellationUserId

null | integer

Unique identifier for the user who canceled the request

data.items.comment

string

Comments

The leave-account resource

Get a leave by id

⌘I

Documentation

Files

Organization Structure API

Core HR API

Expenses API

Invoices API

Absences API

Office API

Project API

Schedule API

Timesheet API

Mealvouchers API

Compensation API

Training API

List leaves

Headers

Query Parameters

Response

Fields