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

# Listar clusters

`GET /{alias}/customers/clusters`

Lista todos os clusters de clientes

## Path parameters

- `alias` string, required

## Response `200`

Clusters listados com sucesso

- object — Representa uma paginação com meta
  - `data` Cluster[]
    - `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.
  - `meta` object
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
      - `links` object
        - `previous` string
        - `next` string

## Other responses

- `400` — Requisição inválida

---

[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)