---
title: "Get a Collective Schedule from a Working Time Arrangement by id."
method: GET
path: "/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId}"
tags: ["Collective Schedules"]
---

# Get a Collective Schedule from a Working Time Arrangement by id.

`GET /schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId}`

## Request

- Base URL: `https://example.ilucca.net`
- URL: `https://example.ilucca.net/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId}`
- Auth: none required
- TypeScript: <https://skmtc.dev/luccasoftware/apis/lucca-expenses/docs/schedule/api/working-time-arrangements/:workingTimeArrangementId/collective-schedules/:collectiveScheduleId/get.ts> (a function with typed inputs; its response is checked against the schema)

<Warning>
**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.
</Warning>

Get a Collective Schedule of a Working Time Arrangement by id

## Response `200`

OK

- CollectiveSchedule: 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.
  - `id` integer, required: The unique identifier of this Collective Schedule.
  - `workingTimeArrangementId` integer, required: The unique identifier of the Working Time Arrangement this Collective Schedule belongs to.
  - `startsOn` string, date, nullable: The date (included) from which this Collective Schedule is applicable. Must be left null for the very first Collective Schedule of a Working Time Arrangement.
  - `endsOn` string, date, nullable: The date (included) from which this Collective Schedule is no longer applicable. Is null for the last Collective Schedule of a Working Time Arrangement. Can not be modified as its equal to the day before the next applicable Collective Schedule for this Working Time Arrangement.
  - `pattern` union, required: The Pattern this Collective Schedule implements. Depends on the Shape.
    - SingleWeekPattern
      - `shape` 'singleWeek' | 'oddEvenWeeks', required
      - `monday` SchedulePatternDay
        - `id` integer, required
        - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
        - `shifts` SchedulePatternShift[], required
          - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
          - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
          - `duration` Duration, required
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `workDuration` Duration
          - `iso` string, duration: ISO-8601 formatted duration.
          - `unit` 'day' | 'hour'
      - `tuesday` SchedulePatternDay
        - `id` integer, required
        - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
        - `shifts` SchedulePatternShift[], required
          - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
          - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
          - `duration` Duration, required
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `workDuration` Duration
          - `iso` string, duration: ISO-8601 formatted duration.
          - `unit` 'day' | 'hour'
      - `wednesday` SchedulePatternDay
        - `id` integer, required
        - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
        - `shifts` SchedulePatternShift[], required
          - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
          - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
          - `duration` Duration, required
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `workDuration` Duration
          - `iso` string, duration: ISO-8601 formatted duration.
          - `unit` 'day' | 'hour'
      - `thursday` SchedulePatternDay
        - `id` integer, required
        - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
        - `shifts` SchedulePatternShift[], required
          - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
          - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
          - `duration` Duration, required
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `workDuration` Duration
          - `iso` string, duration: ISO-8601 formatted duration.
          - `unit` 'day' | 'hour'
      - `friday` SchedulePatternDay
        - `id` integer, required
        - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
        - `shifts` SchedulePatternShift[], required
          - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
          - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
          - `duration` Duration, required
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `workDuration` Duration
          - `iso` string, duration: ISO-8601 formatted duration.
          - `unit` 'day' | 'hour'
      - `saturday` SchedulePatternDay
        - `id` integer, required
        - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
        - `shifts` SchedulePatternShift[], required
          - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
          - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
          - `duration` Duration, required
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `workDuration` Duration
          - `iso` string, duration: ISO-8601 formatted duration.
          - `unit` 'day' | 'hour'
      - `sunday` SchedulePatternDay
        - `id` integer, required
        - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
        - `shifts` SchedulePatternShift[], required
          - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
          - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
          - `duration` Duration, required
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `workDuration` Duration
          - `iso` string, duration: ISO-8601 formatted duration.
          - `unit` 'day' | 'hour'
    - OddEvenWeeksPattern
      - `shape` 'singleWeek' | 'oddEvenWeeks', required
      - `oddWeek` SingleWeekPattern
        - `shape` 'singleWeek' | 'oddEvenWeeks', required
        - `monday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `tuesday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `wednesday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `thursday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `friday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `saturday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `sunday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
      - `evenWeek` SingleWeekPattern
        - `shape` 'singleWeek' | 'oddEvenWeeks', required
        - `monday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `tuesday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `wednesday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `thursday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `friday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `saturday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
        - `sunday` SchedulePatternDay
          - `id` integer, required
          - `dayOffType` 'off' | 'partTime' | 'weeklyRest': When a user requests a leave during a period, the type of day off defines whether the off days of the period must be counted according to the settings of the absence (unit and part time policy).
          - `shifts` SchedulePatternShift[], required
            - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
            - `startsAt` string, time, nullable: Not null when the Working Time Arrangement Unit is "time". Must be left null otherwise.
            - `duration` Duration, required
              - …
          - `workDuration` Duration
            - `iso` string, duration: ISO-8601 formatted duration.
            - `unit` 'day' | 'hour'
  - `splitsHalfDays` boolean, required: Should half-days be discriminated? In other words, should shifts belong to half days rather than just the day itself?

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/luccasoftware/apis/lucca-expenses.md) - [All operations](https://skmtc.dev/luccasoftware/apis/lucca-expenses/llms.txt) - [OpenAPI document](https://skmtc.dev/luccasoftware/apis/lucca-expenses/revisions/110f9897756c?raw)