> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Retrieve Customer Segment

> Retrieves a specific customer segment as identified by the `segment_id` value.

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

## Example

```ts automations/square-retrieve-customer-segment.automation.ts theme={null}
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](https://developer.squareup.com/reference/square/customer-segments-api/retrieve-customer-segment) 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.