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

> Searches for availabilities for booking.

`square.searchAvailability` searches for availabilities for booking.

## Example

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

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

  square.searchAvailability({
    query: {
      filter: {
        startAtRange: {},
      },
    },
  })
})
```

## Inputs

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

| Field   | Type                             | Required | Default | Description                                                              |
| ------- | -------------------------------- | -------- | ------- | ------------------------------------------------------------------------ |
| `query` | `Square.SearchAvailabilityQuery` | Yes      | —       | Query conditions used to filter buyer-accessible booking availabilities. |

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

## Output

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