GET Shifts

get

https://www.humanity.com/api/v2/shifts

/shifts Permission level: 7

Query Params

overnight

int32

start_limit

int32

Works only with mode : Open, it behaves like offset in this case.

end_limit

int32

Works only with mode : Open, it behaves like limit in a combination with start_limit parameter

start_date

string

end_date

string

mode

string

Can be one of the following: overview, location, schedule, incomplete, employees, employee, open, openapproval, confirm, onnow, late, upcoming, recent, multiple.
If mode is not set, it defaults to 'employee'.

schedule

string

Works only with modes: confirm, location, schedule, employees, where it acts as a position filter. Accepts a string with comma-separated Position IDs

location

int32

Works only with modes: confirm, employees, where it acts as a location filter. Accepts an integer which represents a Location ID

employees

string

Works with modes: confirm, employees, where it accepts a string with comma-separated Employee IDs.
With modes upcoming, recent, or employee, it accepts only one Employee ID. In all cases it behaves like a filter by employee(s).

detailed

int32

If set to 1, the response will have additional information regarding employees, their conflicts, availability to work, count of shifts in a series if they are part of a series.
It's recommended not to use this parameter if not needed because it will make request noticeably slower.

budget

int32

Works with all modes except for "multiple". Accepted values: 0 or 1. If set to 1, the response will have extra information about budget data entered for the date range between provided start_date and end_date

vacation

int32

[0, 1]

filter_by_site

string

filter_by_employee

string

filter_by_skill

string

filled

int32

[0, 1]

include_ghost_shifts

boolean

Works only with modes location and schedule. If set to true, the response will include shifts of employees which are assigned to positions listed with the parameter "schedule" or all positions under a location provided with the parameter "location".

fields[shift]

string

Use this parameter to return only specific fields in the response, reducing payload size. Pass the resource type in brackets and a comma-separated list of the fields you want included.

Example: https://www.humanity.com/api/v2/shifts?mode=overview&start_date=2026-02-01&end_date=2026-03-01&fields[shift]=employees,schedule,schedule_name,start_timestamp,end_timestamp

Responses

200200

400400