GET /workforce/calendars/r1/work-shifts

Http Verb	GET
Url	/workforce/calendars/r1/work-shifts
Permissions required
Personally Identifiable Information (PII)	No
Sensitive Information	No
Last Modified Version	r1
Released since	`2024 W2 (FSM 17.0)`
Deprecated since
Removed since
Tech Tags	PAGINATION ORDERING-SERVER-SIDE

Business Logic

This API returns a list of Work Shift filtered by input criteria.

Query String Parameters

Filter ℹ️

Field	Validations	Note
id
resourceId
startDate
endDate
breakStart
breakEnd
operationCenterId
typeId
note
overtimeMinute
resourceWorkshift		`true` → Returns only shifts of individual resources. `false` → Returns only crew shell workshifts `null` → returning all shifts, including those from crew shells

Order ℹ️

Default Order

id (ASC)

Possible order values

All response payload fields.

Page ℹ️

Default.

Fields ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field	Note
id
resourceId
startDate
endDate
breakStart
breakEnd
operationCenterId
typeId
note
overtimeMinute

Response error codes