List Customers - Automate.ax

square.listCustomers lists customer profiles associated with a Square account.

Example

automations/square-list-customers.automation.ts

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

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

  square.listCustomers({
    cursor: "cursor",
    limit: 1,
    sortField: "DEFAULT",
    sortOrder: "DESC",
    count: true,
  })
})

Inputs

Every input accepts a compatible signal. It requires CUSTOMERS_READ.

Field	Type	Required	Default	Description
`cursor`	`string \| null`	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see Pagination.
`limit`	`number \| null`	No	100	The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. For more information, see Pagination.
`sortField`	`Square.CustomerSortField \| null`	No	`DEFAULT`	Indicates how customers should be sorted. The default value is `DEFAULT`.
`sortOrder`	`Square.SortOrder \| null`	No	`ASC`	Indicates whether customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. The default value is `ASC`.
`count`	`boolean \| null`	No	`false`	Indicates whether to return the total count of customers in the `count` field of the response. The default value is `false`.

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

Output

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