> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Retrieve Scheduled Shift

> Retrieves a scheduled shift by ID.

`square.retrieveScheduledShift` retrieves a scheduled shift by ID.

## Example

```ts automations/square-retrieve-scheduled-shift.automation.ts theme={null}
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](https://developer.squareup.com/reference/square/labor-api/retrieve-scheduled-shift) 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.