• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
ShiftFilter

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

Required

Fetch shifts for the specified location.

employee_ids
string [ ]

Deprecated

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

status
string

Fetch a Shift instance by Shift.status.

start
TimeRange

Fetch Shifts that start in the time range - Inclusive.

end
TimeRange

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

workday
ShiftWorkday

Fetch the Shifts based on workday date range.

team_member_ids
string [ ]

Required

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

Share Feedback

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