curl --request GET \
--url https://{host}/api/v3/leaveRequests \
--header 'Authorization: <authorization>'{
"data": {
"items": [
{
"id": 123,
"leavePeriodId": 123,
"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
}
]
},
"status": 0,
"creationDate": "2023-11-07T05:31:56Z",
"nextApproverId": "<unknown>",
"cancellationUserId": "<unknown>",
"cancellationDate": "<unknown>",
"isActive": true,
"approvals": [
{
"id": 123,
"date": "2023-11-07T05:31:56Z",
"approverId": 123,
"substitutedApproverId": 0,
"approved": true,
"comment": "<string>"
}
],
"cancellationRequests": [
{
"id": 123,
"authorId": 123,
"comment": "<string>",
"rank": 0,
"approved": true,
"creationDate": "2023-11-07T05:31:56Z",
"nextApproverId": "<unknown>",
"isActive": true
}
]
}
],
"count": 123
}
}Retrieve a list of Leave Requests.
curl --request GET \
--url https://{host}/api/v3/leaveRequests \
--header 'Authorization: <authorization>'{
"data": {
"items": [
{
"id": 123,
"leavePeriodId": 123,
"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
}
]
},
"status": 0,
"creationDate": "2023-11-07T05:31:56Z",
"nextApproverId": "<unknown>",
"cancellationUserId": "<unknown>",
"cancellationDate": "<unknown>",
"isActive": true,
"approvals": [
{
"id": 123,
"date": "2023-11-07T05:31:56Z",
"approverId": 123,
"substitutedApproverId": 0,
"approved": true,
"comment": "<string>"
}
],
"cancellationRequests": [
{
"id": 123,
"authorId": 123,
"comment": "<string>",
"rank": 0,
"approved": true,
"creationDate": "2023-11-07T05:31:56Z",
"nextApproverId": "<unknown>",
"isActive": true
}
]
}
],
"count": 123
}
}API key. Value must be formatted like so: lucca application={api_key}.
OK
Show child attributes
Show child attributes
Unique identifier for the LeaveRequest
Unique identifier for the attached LeavePeriod
Show child attributes
Unique identifier for the LeavePeriod
Unique identifier for the user
Has the value true for approved LeavePeriod or the value false for LeavePeriod pending approval
Time at which the LeavePeriod was approved
Unique identifier for the attached document
Show child attributes
Status of the Leave request. Can be :
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
0, 2, 3, 4, 5 Time at which the object was created
Unique identifier for the next approver
Unique identifier for the user that cancelled the Leave Request
Time at which the object was cancelled
Has the value true for acitve Leave Request or the value false for cancelled Leave Request
Show child attributes
Unique identifier for the LeaveRequestApproval
Unique identifier for the approver
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
0, 2, 3, 4, 5 Has the value true for approved LeaveRequest or the value false for LeaveRequest pending approval
Comments
Show child attributes
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
0, 2, 3, 4, 5 Was this page helpful?