Search Scheduled Shifts - Automate.ax

square.searchScheduledShifts returns a paginated list of scheduled shifts, with optional filter and sort settings.

Example

automations/square-search-scheduled-shifts.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Search Square Scheduled Shifts", () => {
  onDashboardRun({ title: "Search Square Scheduled Shifts" })

  square.searchScheduledShifts({
    query: {
      filter: {
        assignmentStatus: "ASSIGNED",
      },
      sort: {
        field: "CREATED_AT",
        order: "ASC",
      },
    },
    limit: 2,
    cursor: "xoxp-1234-5678-90123",
  })
})

Inputs

Every input accepts a compatible signal. It requires TIMECARDS_READ.

Field	Type	Required	Default	Description
`query`	`Square.ScheduledShiftQuery`	No	—	Query conditions used to filter and sort the results.
`limit`	`number`	No	50	The maximum number of results to return in a single response page. The default value is 50.
`cursor`	`string`	No	—	The pagination cursor returned by the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.

Use the official SearchScheduledShifts reference for provider field semantics and limits.

Output

Returns the official Square.SearchScheduledShiftsResponse response as a codec-safe object. Square integer money amounts remain bigint values.