Reads all Shifts

get

https://api.factorialhr.com/api/2026-04-01/resources/shift_management/shifts

Reads all Shifts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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[]

start_at

string

Filter shifts that end on or after this date. Only the date (calendar day) is used; the time part is ignored (treated as start of day, 00:00:00). Shifts are included if their end time is at or after the start of the specified day

end_at

string

Filter shifts that start before this date. Only the date (calendar day) is used; the time part is ignored (treated as end of day, 23:59:59). Shifts are included if their start time is before the end of the specified day

only_published

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[]

split_overnight_shifts

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK