GET
/
timmi-settings
/
api
/
working-time-arrangements
/
{workingTimeArrangementId}
/
collective-schedules
/
{collectiveScheduleId}
Get a Collective Schedule from 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
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Path Parameters

​
workingTimeArrangementId
integer
required

The unique identifier of the Working Time Arrangement.

Required range: x >= 0
​
collectiveScheduleId
integer
required

The unique identifier of the Collective Schedule for this Working Time Arrangement.

Response

200
application/json

OK

A Collective Schedule describes the employees' expected working hours over a week.

It comes in two shapes:

  • "Single Week": Working hours are identical every week.
  • "Odd / Even Weeks": Working hours depend on the oddness of the week.