curl --request GET \
--url https://{host}/timmi-settings/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules \
--header 'Authorization: <authorization>'
{
"items": [
{
"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 the list of Collective Schedules from a Working Time Arrangement by id
curl --request GET \
--url https://{host}/timmi-settings/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules \
--header 'Authorization: <authorization>'
{
"items": [
{
"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
Number of items per page
0 <= x <= 100
Next page token
"next_token&fields.root=next"
"2"
Include collection properties.
count
Sort items by a property.
-startsOn
OK
The response is of type object
.