List Workweek Configs - Automate.ax

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

Example

automations/square-list-workweek-configs.automation.ts

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