Retrieve Loyalty Account - Automate.ax

square.retrieveLoyaltyAccount retrieves a loyalty account.

Example

automations/square-retrieve-loyalty-account.automation.ts

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

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

  square.retrieveLoyaltyAccount({
    accountId: "account_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires LOYALTY_READ.

Field	Type	Required	Default	Description
`accountId`	`string`	Yes	—	The ID of the loyalty account to retrieve.

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

Output

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