Object Index / Definition

You are viewing an old version of the API
Shift​Filter

Defines a filter used in a search for Shift records

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

Properties

Name Description
employee_ids
string [ ]

Fetch shifts for the specified employee.

end
Time​Range

Fetch the Shifts that end in the time range - Inclusive.

location_ids
string [ ]

Fetch shifts for the specified location.

start
Time​Range

Fetch Shifts that start in the time range - Inclusive.

status
string

Fetch a Shift instance by Shift.status.

workday
Shift​Workday

Fetch the Shifts based on workday date range.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?