---
title: "Visualizar clusters"
method: GET
path: "/{alias}/customers/clusters/{id}"
tags: ["Clientes - Clusters"]
---

# Visualizar clusters

`GET /{alias}/customers/clusters/{id}`

Obtém os detalhes de um cluster específico

## Path parameters

- `alias` string, required
- `id` integer, required

## Response `200`

Detalhes visualizados com sucesso

- Cluster — Clusters são grupos de clientes com condições comerciais flexíveis, como preço de produto, frete e forma de entrega
  - `id` integer
  - `name` string
  - `active` boolean
  - `attach_on_signup` boolean
  - `person_type` string
  - `min_order_value` number, float
  - `base_price_percent` integer
  - `payments_ids` integer[] — IDs dos métodos de pagamento
  - `carriers_ids` integer[] — IDs das transportadoras
  - `restrictions` object
    - `include` object
      - `products_ids` integer[]
      - `brands_ids` integer[]
      - `collections_ids` integer[]
      - `categories_ids` integer[]
  - `exclude` object
    - `products_ids` integer[]
    - `brands_ids` integer[]
    - `collections_ids` integer[]
    - `categories_ids` integer[]
  - `include_ids` integer[] — Lista de IDs para inclusão
  - `exclude_ids` integer[] — Lista de IDs para exclusão
  - `created_at` BaseTimestamp
    - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
    - `timezone_type` integer — Número de representação do timezone.
    - `timezone` string — Fuso horário associado.
  - `updated_at` BaseTimestamp
    - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
    - `timezone_type` integer — Número de representação do timezone.
    - `timezone` string — Fuso horário associado.

## Other responses

- `400` — Requisição inválida
- `404` — Cluster não encontrado

---

[API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/revisions/fa16c50bef09/schema)