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

> Searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter.

`square.searchVendors` searches for vendors using a filter against supported [Vendor](entity:Vendor) properties and a supported sorter.

## Example

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

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

  square.searchVendors({})
})
```

## Inputs

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

| Field    | Type                                | Required | Default | Description                                                                                                                                                                                                                                                   |
| -------- | ----------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter` | `Square.SearchVendorsRequestFilter` | No       | —       | Specifies a filter used to search for vendors.                                                                                                                                                                                                                |
| `sort`   | `Square.SearchVendorsRequestSort`   | No       | —       | Specifies a sorter used to sort the returned vendors.                                                                                                                                                                                                         |
| `cursor` | `string`                            | No       | —       | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. |

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

## Output

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