ShiftFilterDeprecated

Defines a filter used in a search for Shift records.

AND logic is used by Square's servers to apply each filter property specified.

Deprecated at Square API version 2025-05-21. See the migration notes.

Link to section

Properties

Link to section

location_ids

string [ ]

Fetch shifts for the specified location.

Link to section

employee_ids

string [ ]

Fetch shifts for the specified employees. DEPRECATED at version 2020-08-26. Use team_member_ids instead.

Link to section

status

string

Fetch a Shift instance by Shift.status.

Link to section

start

Fetch Shift instances that start in the time range - Inclusive.

Link to section

end

Fetch the Shift instances that end in the time range - Inclusive.

Link to section

workday

Fetch the Shift instances based on the workday date range.

Link to section

team_member_ids

string [ ]

Fetch shifts for the specified team members. Replaced employee_ids at version "2020-08-26".