Bulk Retrieve Customers - Automate.ax

square.bulkRetrieveCustomers retrieves multiple customer profiles.

Example

automations/square-bulk-retrieve-customers.automation.ts

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

export default automation("Bulk Square Retrieve Customers", () => {
  onDashboardRun({ title: "Bulk Square Retrieve Customers" })

  square.bulkRetrieveCustomers({
    customerIds: [
      "8DDA5NZVBZFGAX0V3HPF81HHE0",
      "N18CPRVXR5214XPBBA6BZQWF3C",
      "2GYD7WNXF7BJZW1PMGNXZ3Y8M8",
    ],
  })
})

Inputs

Every input accepts a compatible signal. It requires CUSTOMERS_READ.

Field	Type	Required	Default	Description
`customerIds`	`string[]`	Yes	—	The IDs of the customer profiles to retrieve.

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

Output

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