curl --request GET \
--url https://{host}/timmi-settings/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId} \
--header 'Authorization: <authorization>'
{
"id": 1,
"workingTimeArrangementId": 1,
"startsOn": "2023-12-25",
"endsOn": "2023-12-25",
"pattern": {
"shape": "singleWeek",
"monday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"tuesday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"wednesday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"thursday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"friday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"saturday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"sunday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
},
"splitsHalfDays": true
}
This is a beta feature. You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support.
Get a Collective Schedule of a Working Time Arrangement by id
curl --request GET \
--url https://{host}/timmi-settings/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId} \
--header 'Authorization: <authorization>'
{
"id": 1,
"workingTimeArrangementId": 1,
"startsOn": "2023-12-25",
"endsOn": "2023-12-25",
"pattern": {
"shape": "singleWeek",
"monday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"tuesday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"wednesday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"thursday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"friday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"saturday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
},
"sunday": {
"id": 1,
"dayOffType": "off",
"shifts": [
{
"position": "firstHalf",
"startsAt": "<string>",
"duration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
],
"workDuration": {
"value": 1,
"iso": "<string>",
"unit": "days"
}
}
},
"splitsHalfDays": true
}
API key. Value must be formatted like so: lucca application={api_key}
.
The unique identifier of the Working Time Arrangement.
x >= 0
The unique identifier of the Collective Schedule for this Working Time Arrangement.
OK
A Collective Schedule describes the employees' expected working hours over a week.
It comes in two shapes: