---
title: "List Working Time Arrangements."
method: GET
path: "/schedule/api/working-time-arrangements"
tags: ["Working Time Arrangements"]
---

# List Working Time Arrangements.

`GET /schedule/api/working-time-arrangements`

<Warning>
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>

List of Working Time Arrangements.

## Query parameters

- `search` string
- `isPartTime` boolean
- `unit` 'day' | 'hour' | 'time' — An event can be set in: - Day: "I worked for a half day last Monday". - Hour: "I worked for 2 hours last Monday". - Time: "I worked between 10:00 AM and 12:00 AM last Monday".
- `isArchived` boolean
- `currentlyAssignedOnly` boolean
- `sort` 'id' | '-id'
- `page` integer
- `limit` integer
- `fields.root` 'count'

## Response `200`

OK

- object
  - `items` WorkingTimeArrangement[]
    - `id` integer, required — The unique identifier of this Working Time Arrangement.
    - `name` string, required — The unique name for this Working Time Arrangement.
    - `description` string, nullable, required — An optional description.
    - `unit` 'day' | 'hour' | 'time', required — An event can be set in: - Day: "I worked for a half day last Monday". - Hour: "I worked for 2 hours last Monday". - Time: "I worked between 10:00 AM and 12:00 AM last Monday".
    - `referencePeriod` union — The period the Contract Working Time Duration applies over.
      - ReferenceWeek
        - `frequencyType` 'week' | 'year', required
        - `firstDayOfWeek` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday', required
      - ReferenceYear
        - `frequencyType` 'week' | 'year', required
        - `firstMonth` 'january' | 'february' | 'march' | 'april' | 'may' | 'june' | 'july' | 'august' | 'september' | 'october' | 'november' | 'december', required
    - `contractWorkingTimeDuration` Duration
      - `iso` string, duration — ISO-8601 formatted duration.
      - `unit` 'day' | 'hour'
    - `referenceWorkingTimeDuration` Duration
      - `iso` string, duration — ISO-8601 formatted duration.
      - `unit` 'day' | 'hour'
    - `fullTimeEquivalent` number, required — By default, equal to the ratio between the Contract Working Time Duration and the Reference Working Time Duration.
    - `fullDayAbsence` FullDayAbsence
      - `duration` Duration, required
        - `iso` string, duration — ISO-8601 formatted duration.
        - `unit` 'day' | 'hour'
      - `absenceAccountIds` integer[], required — The identifiers of the absence accounts this full day absence applies to.
      - `absenceCategoryIds` integer[], required — The identifiers of the absence categories this full day absence applies to.
    - `publicHolidaysCalendar` object, required — Unique identifier of the Public Holidays Calendar applicable to these employees.
      - `id` integer, required — The unique identifier of this holiday calendar.
      - `name` string, nullable
    - `isPartTime` boolean, required — True whenever the Full Time Equivalent is below 1 (eg <100%).
    - `isArchived` boolean, required — True whenever this Working Time Arrangement should no longer be given to employees.
    - `isScheduleValid` boolean, required — False if there is not at least one Collective Schedule. In this case, the Working Time Arrangement can't be given to any employee through his Work Contract.
    - `currentAssignmentsCount` integer
    - `timesheetRegulation` TimesheetRegulation
      - `id` integer, required
      - `name` string, required
    - `currentSchedulePatternSummary` SchedulePatternSummary
      - `shape` 'singleWeek' | 'oddEvenWeeks', required
      - `days` object[], 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).
        - `workPosition` 'firstHalf' | 'secondHalf' | 'fullDay'
        - `workDuration` number, nullable
        - `workDurationUnit` 'day' | 'hour' — Duration unit: days or hours.
    - `authorizedCommands` string[], required — The actions the current authenticated User can make on this Working Time Arrangement. Depends on his permissions.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/luccasoftware/apis/lucca-expenses.md) · [All operations](https://skmtc.net/luccasoftware/apis/lucca-expenses/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/luccasoftware/lucca-expenses/revisions/110f9897756c/schema)