Documentation
Organization Structure API
- Axis-sections
- Departments
- Legal-Units
- Establishments
Core HR API
- Employees Directory
- Guides
Cleemy Expenses API
- Expense-temp-items
- Expense-claims
- Expense-claim-items
- Exports
Cleemy Invoices API
- Guides
Timmi Absences API
Timmi Office API
- User-locations
- Work-locations
Timmi Project API
- Clients
- Projects
- Project services
- Organizations
- Financials
Timmi Settings API
- UserDates
- Workcycle-exceptions
- Working-time-arrangement
Timmi Timesheet API
- Time-entries
- Timesheets
- Reports
- Guides
Pagga Mealvouchers API
- Statutory
- Computation
Pagga Remuneration API
- Fixed-natures
- Fixed-items
- Variable-natures
- Variable-items
Poplee Training API
- Training-demands
- Realized-trainings
Get a leave request by id
Retrieve a single Leave Request by its unique identifier.
curl --request GET \
--url https://{host}/api/v3/leaveRequests/{id} \
--header 'Authorization: <authorization>'{
"data": {
"id": 123,
"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
}
]
},
"status": 0,
"creationDate": "2023-11-07T05:31:56Z",
"nextApproverId": null,
"cancellationUserId": null,
"cancellationDate": null,
"isActive": true,
"approvals": [
{
"id": 123,
"date": "2023-11-07T05:31:56Z",
"approverId": 123,
"substitutedApproverId": null,
"approved": true,
"comment": "<string>"
}
],
"cancellationRequests": [
{
"id": 123,
"authorId": 123,
"comment": "<string>",
"rank": 0,
"approved": true,
"creationDate": "2023-11-07T05:31:56Z",
"nextApproverId": null,
"isActive": true
}
]
}
}Headers
API key. Value must be formatted like so: lucca application={api_key}.
Path Parameters
ID of the leave-request.
Response
Unique identifier for the LeaveRequest
Unique identifier for the attached LeavePeriod
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
Leave objects
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
Fields
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
Fields
0 = PENDING_APPROVAL
2 = APPROVED
3 = DENIED
4 = CANCELLED
5 = CANCELLATION_PENDING
0, 2, 3, 4, 5 Was this page helpful?
curl --request GET \
--url https://{host}/api/v3/leaveRequests/{id} \
--header 'Authorization: <authorization>'{
"data": {
"id": 123,
"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
}
]
},
"status": 0,
"creationDate": "2023-11-07T05:31:56Z",
"nextApproverId": null,
"cancellationUserId": null,
"cancellationDate": null,
"isActive": true,
"approvals": [
{
"id": 123,
"date": "2023-11-07T05:31:56Z",
"approverId": 123,
"substitutedApproverId": null,
"approved": true,
"comment": "<string>"
}
],
"cancellationRequests": [
{
"id": 123,
"authorId": 123,
"comment": "<string>",
"rank": 0,
"approved": true,
"creationDate": "2023-11-07T05:31:56Z",
"nextApproverId": null,
"isActive": true
}
]
}
}