Retrieve Customer Group - Automate.ax

square.retrieveCustomerGroup retrieves a specific customer group as identified by the group_id value.

Example

automations/square-retrieve-customer-group.automation.ts

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

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

  square.retrieveCustomerGroup({
    groupId: "group_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires CUSTOMERS_READ.

Field	Type	Required	Default	Description
`groupId`	`string`	Yes	—	The ID of the customer group to retrieve.

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

Output

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