List Merchants - Automate.ax

square.listMerchants provides details about the merchant associated with a given access token.

Example

automations/square-list-merchants.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

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

  square.listMerchants({
    cursor: 1,
  })
})

Inputs

Every input accepts a compatible signal. It requires MERCHANT_PROFILE_READ.

Field	Type	Required	Default	Description
`cursor`	`number \| null`	No	—	The cursor generated by the previous response.

Use the official ListMerchants reference for provider field semantics and limits.

Output

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