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

# Listar clientes

`GET /{alias}/customers`

Lista todos os clientes

## Path parameters

- `alias` string, required

## Query parameters

- `include` string[]
- `filters` CustomerCriteria — Mapeia os filtros disponíveis para pesquisa baseada em campanhas, datas de compra/criação, origem e status.
  - `state_uf` string[] — Estado (UF) associado ao registro.
  - `active` integer — Status do registro (ativa=1 ou inativa=0).
  - `clusters_ids` integer[] — IDs dos clusters associados aos clientes.
  - `buy_product_id` integer[] — IDs dos produtos comprados pelos clientes.
  - `total_orders` integer — Número total de pedidos feitos pelo cliente.
  - `bought_at` string — Filtro por data de compra.

## Response `200`

Lista de clientes retornada com sucesso

- object — Representa uma paginação com meta
  - `data` Customer[]
    - `id` integer
    - `merchant_id` integer
    - `marketplace_id` integer
    - `active` boolean
    - `type` string
    - `cluster_id` integer
    - `name` string
    - `first_name` string
    - `last_name` string
    - `generic_name` string
    - `cpf` string
    - `spreadsheet` object
      - `data` object
        - `brands` string
        - `city` string
        - `purchased_brands` string
        - `last_order_date` object
          - `date` string, date-time
          - `timezone_type` integer
          - `timezone` string
        - `last_order_value` string
        - `purchased_categories` string
        - `number` string
        - `uf` string
        - `phone` string
        - `street` string
        - `phone_number` string
        - `categories` string
        - `neighborhood` string
        - `complement` string
        - `phone_code` string
    - `phone` object
      - `area_code` string — Código de área do telefone
      - `full_number` string — Número do telefone
      - `number` string — Número do telefone
      - `formated_number` string — Número do telefone formatado
      - `whatsapp_link` string, uri
    - `razao_social` string
    - `cnpj` string
    - `state_registration` string
    - `email` string, email
    - `password` string
    - `birthday` string, date
    - `newsletter` boolean
    - `whatsapp` boolean
    - `social_driver` string
    - `social_id` integer
    - `ip` string
    - `token` string
    - `utm_source` string
    - `utm_campaign` string
    - `notes` string
    - `login_url` string, uri
    - `anonymized` boolean
  - `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)