Retrieve Customer Segment - Automate.ax

square.retrieveCustomerSegment retrieves a specific customer segment as identified by the segment_id value.

Example

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

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

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

  square.retrieveCustomerSegment({
    segmentId: "segment_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires CUSTOMERS_READ.

Field	Type	Required	Default	Description
`segmentId`	`string`	Yes	—	The Square-issued ID of the customer segment.

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

Output

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