DocumentationAPI Reference
API Reference

List Shifts

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

Lists shifts matching the given filters. Either provide ids (ignores all other filters) or provide start, end, and at least one of employeeIds or scheduleIds. The time window must be no longer than 1 month. Defaults to returning planned and published shifts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of uuids

Filter by shift IDs. If provided, other filters are ignored.

ids
date-time

Start datetime for the shift window (ISO-8601 datetime string). Required if ids not provided.

date-time

End datetime for the shift window (ISO-8601 datetime string). Required if ids not provided.

employeeIds
array of strings

Filter by employee IDs. Use the string "null" as a value to include unassigned shifts (e.g. employeeIds[]=10&employeeIds[]=null).

employeeIds
scheduleIds
array of uuids

Filter by schedule IDs.

scheduleIds
statuses
array of strings
Defaults to planned,published

Filter by shift statuses.

statuses
integer
≥ 1
Defaults to 1

The starting page for pagination.

integer
1 to 1000
Defaults to 1000

The number of items to be returned.

Responses

Updated 13 days ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago