> ## 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.

# List Workweek Configs

> Returns a list of `WorkweekConfig` instances for a business.

`square.listWorkweekConfigs` returns a list of `WorkweekConfig` instances for a business.

## Example

```ts automations/square-list-workweek-configs.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("List Square Workweek Configs", () => {
  onDashboardRun({ title: "List Square Workweek Configs" })

  square.listWorkweekConfigs({
    limit: 1,
    cursor: "cursor",
  })
})
```

## Inputs

Every input accepts a compatible signal. It requires `TIMECARDS_SETTINGS_READ`.

| Field    | Type             | Required | Default | Description                                                         |
| -------- | ---------------- | -------- | ------- | ------------------------------------------------------------------- |
| `limit`  | `number \| null` | No       | —       | The maximum number of `WorkweekConfigs` results to return per page. |
| `cursor` | `string \| null` | No       | —       | A pointer to the next page of `WorkweekConfig` results to fetch.    |

Use the official [ListWorkweekConfigs reference](https://developer.squareup.com/reference/square/labor-api/list-workweek-configs) for provider field semantics and limits.

## Output

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