Documentation
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
curl --request GET \
--url https://{host}/api/v3/userdates \
--header 'Authorization: <authorization>'{
"data": {
"items": [
{
"source": 1,
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
],
"am": {
"source": 1,
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
]
},
"pm": {
"source": 1,
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
]
}
}
]
}
}List UserDates.
Retrieve a list of UserDates.
Performance
In order to keep satisfactory response times and performance, please filter the request on a limited set of OwnerId[] and reduce the period date=between,{start},{end}.
As a rule of thumb, do not request for more than ~10 owners over a whole month.
Format
The date query parameter should match the form ?date=between,{start},{includedEnd}.
curl --request GET \
--url https://{host}/api/v3/userdates \
--header 'Authorization: <authorization>'{
"data": {
"items": [
{
"source": 1,
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
],
"am": {
"source": 1,
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
]
},
"pm": {
"source": 1,
"dtt": "07:00:00",
"drt": "04:15:00",
"draj": "03:30:00",
"isHoliday": true,
"isWeeklyRest": true,
"items": [
{
"type": "ptt",
"startsAt": "2023-11-07T05:31:56Z",
"duration": "<string>",
"timeline": "WorkCycle"
}
]
}
}
]
}
}Headers
API key. Value must be formatted like so: lucca application={api_key}.
Query Parameters
User's identifiers.
x >= 1The period over which working hours should be returned for given Users. Format: 'between,{start},{includedEnd}'.
"between,2021-01-01,2021-02-01"
List of all fields to be returned by the server.
Example: ?fields=ownerId,date,dtt,drt,draj, items[startsAt,duration,type,timeline
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
- 1: WorkCycle
- 2: Public Holidays
- 3: WorkCycle Exception
- 5: Leave (from Lucca Absences)
- 6: Entry (from Lucca Timesheet)
1, 2, 3, 5, 6 Theoretical working time. The work duration the User should comply with on this day. It is the result of the workcycle, minus the potential public holidays, delta potential workcycle exception overrides.
"07:00:00"
Actual working time. The actual time the User spent working on this day. Results from the time-entries entered in Lucca Timesheet. If no time-entry has been entered, then defaults to the DTT value.
"04:15:00"
Leave duration.
"03:30:00"
Is this day a holiday in the User's holidays calendar?
Is this the weekly rest day (most often, Sundays) in the User's workcycle?
All events for this day and User.
Show child attributes
Show child attributes
Type of event:
ptt: Theoretical working hours, eg "What the User should be working".prt: Actual working hours, eg "What the User actually did". If nothing was entered in Lucca Timesheet nor Lucca Absences, then ptt are duplicated as prt.praj: Leave of absences.
ptt, prt, praj Start of the event.
Duration of the event.
The source from which this event was pushed.
WorkCycle, PublicHoliday, Exception, Leave, Entry Description of the first half of the day.
Show child attributes
Show child attributes
- 1: WorkCycle
- 2: Public Holidays
- 3: WorkCycle Exception
- 5: Leave (from Lucca Absences)
- 6: Entry (from Lucca Timesheet)
1, 2, 3, 5, 6 Theoretical working time. The work duration the User should comply with on this day. It is the result of the workcycle, minus the potential public holidays, delta potential workcycle exception overrides.
"07:00:00"
Actual working time. The actual time the User spent working on this day. Results from the time-entries entered in Lucca Timesheet. If no time-entry has been entered, then defaults to the DTT value.
"04:15:00"
Leave duration.
"03:30:00"
Is this day a holiday in the User's holidays calendar?
Is this the weekly rest day (most often, Sundays) in the User's workcycle?
All events for this day and User.
Show child attributes
Show child attributes
Type of event:
ptt: Theoretical working hours, eg "What the User should be working".prt: Actual working hours, eg "What the User actually did". If nothing was entered in Lucca Timesheet nor Lucca Absences, then ptt are duplicated as prt.praj: Leave of absences.
ptt, prt, praj Start of the event.
Duration of the event.
The source from which this event was pushed.
WorkCycle, PublicHoliday, Exception, Leave, Entry Description of the second half of this day.
Show child attributes
Show child attributes
- 1: WorkCycle
- 2: Public Holidays
- 3: WorkCycle Exception
- 5: Leave (from Lucca Absences)
- 6: Entry (from Lucca Timesheet)
1, 2, 3, 5, 6 Theoretical working time. The work duration the User should comply with on this day. It is the result of the workcycle, minus the potential public holidays, delta potential workcycle exception overrides.
"07:00:00"
Actual working time. The actual time the User spent working on this day. Results from the time-entries entered in Lucca Timesheet. If no time-entry has been entered, then defaults to the DTT value.
"04:15:00"
Leave duration.
"03:30:00"
Is this day a holiday in the User's holidays calendar?
Is this the weekly rest day (most often, Sundays) in the User's workcycle?
All events for this day and User.
Show child attributes
Show child attributes
Type of event:
ptt: Theoretical working hours, eg "What the User should be working".prt: Actual working hours, eg "What the User actually did". If nothing was entered in Lucca Timesheet nor Lucca Absences, then ptt are duplicated as prt.praj: Leave of absences.
ptt, prt, praj Start of the event.
Duration of the event.
The source from which this event was pushed.
WorkCycle, PublicHoliday, Exception, Leave, Entry Was this page helpful?