These docs are for v2026-01-01. Click to read the latest docs for v2026-07-01.

Reads all Shifts

Reads all Shifts

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

Filter shifts by their unique identifiers. Returns only shifts matching the provided IDs. If an empty array is provided, returns no results

ids[]
without_ids[]
array of integers

Exclude shifts with these identifiers from the results. Useful for filtering out specific shifts while keeping others

without_ids[]
employee_ids[]
array of integers

Filter shifts by employee identifiers. Returns only shifts assigned to the specified employees. If not provided, returns shifts for all accessible employees

employee_ids[]
location_ids[]
array of integers

Filter shifts by location identifiers. Returns shifts that occur at the specified locations. Can be combined with employee_ids for more precise filtering

location_ids[]
string

Filter shifts that end on or after this date/time. Shifts are included if their end time is at or after the specified start_at time

string

Filter shifts that start before this date/time. Shifts are included if their start time is before the specified end_at time

boolean

When true, returns only shifts with state 'published' (visible to employees). When false, returns shifts in all states (draft, published, backup) based on your permissions

only_states[]
array of strings
enum

Filter shifts by their state. Provide an array of states ('draft', 'published', 'backup') to include. Can be combined with other filters for precise control

only_states[]
boolean

When true, shifts that span across midnight (overnight shifts) are split into two separate shift objects - one for each calendar day. This makes it easier to display shifts in day-based views

Response

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