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

> Retrieve a collection of bookings.

`square.listBookings` retrieve a collection of bookings.

## Example

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

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

  square.listBookings({
    limit: 1,
    cursor: "cursor",
    customerId: "customer_id",
    teamMemberId: "team_member_id",
    locationId: "location_id",
    startAtMin: "start_at_min",
    startAtMax: "start_at_max",
  })
})
```

## Inputs

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

| Field          | Type             | Required | Default | Description                                                                                                                                              |
| -------------- | ---------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit`        | `number \| null` | No       | —       | The maximum number of results per page to return in a paged response.                                                                                    |
| `cursor`       | `string \| null` | No       | —       | The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results. |
| `customerId`   | `string \| null` | No       | —       | The customer for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.                                                |
| `teamMemberId` | `string \| null` | No       | —       | The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.                                                |
| `locationId`   | `string \| null` | No       | —       | The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.                                                  |
| `startAtMin`   | `string \| null` | No       | —       | The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used.                                          |
| `startAtMax`   | `string \| null` | No       | —       | The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used.                    |

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

## Output

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