---
title: "List ShiftOverrides."
method: GET
path: "/schedule/api/shift-overrides"
tags: ["ShiftOverrides"]
---

# List ShiftOverrides.

`GET /schedule/api/shift-overrides`

Retrieve a paginated list of ShiftOverrides that satisfy the given query filters.

A ShiftOverride represents a one-time modification to an employee's regular work schedule
for a specific period. It overrides the employee's normal working pattern (defined by their
work cycle) for the specified time range.

## Query parameters

- `id` integer[]
- `employee.id` integer[]
- `startsAt.between` string
- `endsAt.between` string
- `limit` integer
- `page` integer
- `sort` string
- `fields.root` 'count'
- `include` string[]

## Response `200`

OK

- object
  - `items` ShiftOverride[]
    - `id` integer, required — Unique identifier of the ShiftOverride.
    - `employee` object, required — The employee this override applies to.
      - `id` integer
    - `position` 'firstHalf' | 'secondHalf' | 'fullDay', required
    - `startsAt` string, date-time, required — Start date-time of the override.
    - `endsAt` string, date-time, required — End date-time of the override.
    - `duration` ShiftOverrideDuration, required — The duration of the override.
      - `unit` 'days' | 'hours', required — The unit in which the duration value is expressed.
      - `value` number, required — The numeric duration value.
      - `iso` string, required — ISO 8601 duration representation.
    - `workCycleUnit` 'day' | 'hour' | 'time', required — The unit of the work cycle for this override. - `day`: duration expressed in days. - `hour`: duration expressed in hours. - `time`: duration expressed in hours with a specific start time.
    - `nature` 'worked' | 'off' | 'partTime' | 'weeklyRest', required — The nature of the shift override. - `worked`: the employee is working. - `off`: the employee is off. - `partTime`: part-time day. - `weeklyRest`: weekly rest day.
    - `comment` string, nullable — Optional comment associated with the override.
    - `isLocked` boolean, required — Whether the override is locked (cannot be modified).
    - `createdAt` string, date-time, required — Date-time when the override was created.
    - `createdBy` object, nullable — The user who created the override.
      - `id` integer
    - `lastUpdatedAt` string, date-time, required — Date-time when the override was last updated.
    - `lastUpdatedBy` object, nullable — The user who last updated the override.
      - `id` integer
  - `next` string, nullable — Continuation token for the next page.
  - `prev` string, nullable — Continuation token for the previous page.
  - `count` integer, nullable — Total count of items (when requested via `fields.root=count`).

## Other responses

- `400` — Problem
- `401` — Problem
- `500` — Problem

---

[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)
