DocumentationAPI Reference
API Reference

Get Schedule PDF

get
https://{companyDomain}.bamboohr.com/api/v1/scheduling/schedules//pdf

Generates and streams a PDF of the schedule view for the given schedule and date range.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The schedule ID

Query Params
date
required

Start date in YYYY-MM-DD format

date
required

End date in YYYY-MM-DD format

string
enum

Group employees by this field

Allowed:
employeeIds[]
array of strings

Filter by employee IDs. Pass the string "null" as an element to include open shifts.

employeeIds[]
boolean
Defaults to false

Whether to include employees who have no shifts in the date range

boolean
Defaults to false

Whether to include holidays in the PDF

boolean
Defaults to false

Whether to include time-off entries in the PDF

Responses

403

Forbidden

404

Schedule not found

422

Invalid parameters

500

Failed to render PDF

Updated 4 days ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 4 days ago