v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBScheduling
Public API
Get Schedule PDF
Generates and streams a PDF of the schedule view for the given schedule and date range.
OAuth Scopes: scheduling:schedules
get/api/v1/scheduling/schedules/{id}/pdf
Path parameters
idstring required
The schedule ID
Query parameters
startYmdstring date required
Start date in YYYY-MM-DD format
endYmdstring date required
End date in YYYY-MM-DD format
groupBy'location' | 'department' | 'division' | 'jobTitle' | 'team'
Group employees by this field
employeeIds[]string[]
Filter by employee IDs. Pass the string "null" as an element to include open shifts.
includeEmployeesWithoutShiftsboolean
Whether to include employees who have no shifts in the date range
includeHolidaysboolean
Whether to include holidays in the PDF
includeTimeOffboolean
Whether to include time-off entries in the PDF
Response
PDF binary stream