Retrieve Scheduled Shift - Automate.ax

square.retrieveScheduledShift retrieves a scheduled shift by ID.

Example

automations/square-retrieve-scheduled-shift.automation.ts

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

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

  square.retrieveScheduledShift({
    id: "id",
  })
})

Inputs

Every input accepts a compatible signal. It requires TIMECARDS_READ.

Field	Type	Required	Default	Description
`id`	`string`	Yes	—	The ID of the scheduled shift to retrieve.

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

Output

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