Defines filter criteria for a SearchScheduledShifts request.
<- Object
Object
Defines filter criteria for a SearchScheduledShifts request.
Multiple filters in a query are combined as an AND operation.
Return shifts for the specified locations. When omitted, shifts for all locations are returned. If needed, call ListLocations to get location IDs.
Return shifts whose start_at time is within the specified time range (inclusive).
Return shifts assigned to specified team members. If needed, call SearchTeamMembers to get team member IDs.
To return only the shifts assigned to the specified team members, include the assignment_status filter in the query. Otherwise, all unassigned shifts are returned along with shifts assigned to the specified team members.
Return shifts based on whether a team member is assigned. A shift is assigned if the team_member_id field is populated in the draft_shift_details or published_shift details field of the shift.
To return only draft or published shifts, include the scheduled_shift_statuses filter in the query.