ShiftFilter Object - Square API Reference

Name	Description
`location_ids string [ ]`	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 `Shift` instances that start in the time range - Inclusive.
`end TimeRange`	Fetch the `Shift` instances that end in the time range - Inclusive.
`workday ShiftWorkday`	Fetch the `Shift` instances based on the workday date range.
`team_member_ids string [ ]`	Fetch shifts for the specified team members. Replaced `employee_ids` at version "2020-08-26".


          
  
  
            location_ids
          


        

        
      string [ ]

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.

Fetch a Shift instance by Shift.status.

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

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


          
  
  
            workday
          


        

        
    
      ShiftWorkday

Fetch the Shift instances based on the workday date range.


          
  
  
            team_member_ids
          


        

        
      string [ ]

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

Object Index

You are viewing an old version of the API

All Versions

ShiftFilter