v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
ShiftOverrides

List ShiftOverrides.

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.

get/schedule/api/shift-overrides

Query parameters

idinteger[]

Retrieve ShiftOverrides that match one of the given IDs (comma separated list).

employee.idinteger[]

Only retrieve ShiftOverrides that apply to one of the given employees, identified by their ID (comma separated list of int).

startsAt.betweenstring
Example:2023-01-01--2023-01-31

Include only values that fall within the specified range for startsAt. Open-ended ranges can be defined with .. characters.

endsAt.betweenstring
Example:2023-01-01--2023-01-31

Include only values that fall within the specified range for endsAt. Open-ended ranges can be defined with .. characters.

limitinteger

Page size

pageinteger

Page number

sortstring
Example:id

Sort items by ascending or descending property value. Prefix with - for descending order.

fields.root'count'

Include collection properties.

includestring[]

Include extra properties with payload.

Response

OK

nextstring nullable

Continuation token for the next page.

prevstring nullable

Continuation token for the previous page.

countinteger nullable

Total count of items (when requested via fields.root=count).