List leaves

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

The leavePeriod.ownerId query parameter is required ans is used to:

retrieve Leaves of a specific user: ?leavePeriod.ownerId=5
retrieve Leaves of several users: ?leavePeriod.ownerId=5,6
retrieve Leaves of a specific group of users: ?leavePeriod.owner.departmentId=3

The date query parameter can operate comparisons with a given date-time 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

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

{
  "data": {
    "id": "<string>",
    "date": "2023-12-25",
    "isAm": true,
    "leaveAccountId": 123,
    "leaveAccount": {
      "id": 123,
      "name": "<string>"
    },
    "leavePeriodId": 123,
    "leavePeriod": {
      "id": 123,
      "ownerId": 123,
      "isConfirmed": true,
      "confirmationDate": null,
      "attachmentId": null,
      "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": null,
    "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

string

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

leavePeriod.ownerId

integer[]

required

Employee's identifier

date

string

required

{comparator},{date-time}

Response

200

application/json

The response is of type object.

The leave-account resource

Get a leave by id

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

{
  "data": {
    "id": "<string>",
    "date": "2023-12-25",
    "isAm": true,
    "leaveAccountId": 123,
    "leaveAccount": {
      "id": 123,
      "name": "<string>"
    },
    "leavePeriodId": 123,
    "leavePeriod": {
      "id": 123,
      "ownerId": 123,
      "isConfirmed": true,
      "confirmationDate": null,
      "attachmentId": null,
      "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": null,
    "cancellationUserId": null,
    "comment": "<string>"
  }
}