> ## 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 Group

> Retrieves a specific customer group as identified by the `group_id` value.

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

## Example

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