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

# Search Timecards

> Returns a paginated list of `Timecard` records for a business.

`square.searchTimecards` returns a paginated list of `Timecard` records for a business.

## Example

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

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

  square.searchTimecards({
    query: {
      filter: {
        workday: {
          dateRange: {
            startDate: "2019-01-20",
            endDate: "2019-02-03",
          },
          matchTimecardsBy: "START_AT",
          defaultTimezone: "America/Los_Angeles",
        },
      },
    },
    limit: 100,
  })
})
```

## Inputs

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

| Field    | Type                   | Required | Default | Description                                         |
| -------- | ---------------------- | -------- | ------- | --------------------------------------------------- |
| `query`  | `Square.TimecardQuery` | No       | —       | Query filters.                                      |
| `limit`  | `number`               | No       | —       | The number of resources in a page (200 by default). |
| `cursor` | `string`               | No       | —       | An opaque cursor for fetching the next page.        |

Use the official [SearchTimecards reference](https://developer.squareup.com/reference/square/labor-api/search-timecards) for provider field semantics and limits.

## Output

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