> ## 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 Bank Accounts

> Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account.

`square.listBankAccounts` returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account.

## Example

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

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

  square.listBankAccounts({
    cursor: "cursor",
    limit: 1,
    locationId: "location_id",
    customerId: "customer_id",
  })
})
```

## Inputs

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

| Field        | Type             | Required | Default | Description                                                                                                                                                                                                                                                               |
| ------------ | ---------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor`     | `string \| null` | No       | —       | The pagination cursor returned by a previous call to this endpoint. Use it in the next `ListBankAccounts` request to retrieve the next set of results. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. |
| `limit`      | `number \| null` | No       | —       | Upper limit on the number of bank accounts to return in the response. Currently, 1000 is the largest supported limit. You can specify a limit of up to 1000 bank accounts. This is also the default limit.                                                                |
| `locationId` | `string \| null` | No       | —       | Location ID. You can specify this optional filter to retrieve only the linked bank accounts belonging to a specific location.                                                                                                                                             |
| `customerId` | `string \| null` | No       | —       | Customer ID. You can specify this optional filter to retrieve only the linked bank accounts belonging to a specific customer.                                                                                                                                             |

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

## Output

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