GET
/
api
/
v3
/
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,
        "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
integer[]

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

​
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

​
leavePeriod.owner.departmentId
integer[]

Employees department identifier

​
leavePeriod.owner.legalEntityId
integer[]

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

Response

200
application/json

OK

The response is of type object.