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

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Listar Clientes retornados pela busca

> lista clientes retornados pela busca



## OpenAPI

````yaml get /{alias}/search/customers
openapi: 3.0.0
info:
  title: Yampi API
  description: Documentação oficial da API da Yampi
  version: '2.0'
servers:
  - url: https://api.dooki.com.br/v2
    description: Endpoint de produção
security:
  - ApiToken: []
    ApiSecretKey: []
tags:
  - name: Catálogo - Atualização em massa
    x-folder: catalogo/atualizacao-em-massa
  - name: Catálogo - Avaliações de produtos
    x-folder: catalogo/produtos/avaliacoes-de-produtos
  - name: Catálogo - Categorias
    x-folder: catalogo/categorias
  - name: Catálogo - Coleções
    x-folder: catalogo/colecoes
  - name: Catálogo - Comentários de produtos
    x-folder: catalogo/produtos/comentarios-de-produtos
  - name: Catálogo - Customizações
    x-folder: catalogo/customizacoes
  - name: Catálogo - Estoques de SKU
    x-folder: catalogo/skus/estoques-de-sku
  - name: Catálogo - Feeds
    x-folder: catalogo/feeds
  - name: Catálogo - Filtros
    x-folder: catalogo/filtros
  - name: Catálogo - Grupos
    x-folder: catalogo/grupos
  - name: Catálogo - Imagens
    x-folder: catalogo/imagens
  - name: Catálogo - Looks
    x-folder: catalogo/looks
  - name: Catálogo - Kits
    x-folder: catalogo/kits
  - name: Catálogo - Marcas
    x-folder: catalogo/marcas
  - name: Catálogo - Notificações de estoque
    x-folder: catalogo/notificacoes-de-estoque
  - name: Catálogo - Produtos
    x-folder: catalogo/produtos
  - name: Catálogo - Produtos relacionados
    x-folder: catalogo/produtos/produtos-relacionados
  - name: Catálogo - Selos
    x-folder: catalogo/selos
  - name: Catálogo - Sincronizar estoques
    x-folder: catalogo/skus/sincronizar-estoques
  - name: Catálogo - SKUs
    x-folder: catalogo/skus
  - name: Catálogo - Valores de filtros
    x-folder: catalogo/filtros/valores-de-filtros
  - name: Catálogo - Valores de variações
    x-folder: catalogo/variacoes/valores-de-variacoes
  - name: Catálogo - Variações
    x-folder: catalogo/variacoes
  - name: Público - Catálogo
    x-folder: /publico/catalogo
  - name: Público - Busca
    x-folder: /publico/busca
  - name: Público - Loja
    x-folder: /publico/loja
  - name: Público - Frete
    x-folder: /publico/frete
  - name: Checkout - Bancos
    x-folder: checkout/bancos
  - name: Checkout - Links de Pagamento
    x-folder: checkout/links-de-pagamento
  - name: Checkout - Carrinhos abandonados
    x-folder: checkout/carrinhos-abandonados
  - name: Checkout - Configurações de pagamentos
    x-folder: checkout/configuracoes-de-pagamentos
  - name: Checkout - Formas de pagamentos
    x-folder: checkout/formas-de-pagamentos
  - name: Checkout - Gateways de pagamento
    x-folder: checkout/gateways-de-pagamento
  - name: Checkout - Parcelamento
    x-folder: checkout/parcelamento
  - name: Checkout - Status de pedidos
    x-folder: checkout/status-de-pedidos
  - name: Checkout - Transações
    x-folder: checkout/transacoes
  - name: Clientes - Cliente
    x-folder: clientes/cliente
  - name: Clientes - Clusters
    description: >-
      Clusters são grupos de clientes com condições comerciais flexíveis, como
      preço de produto, frete e forma de entrega
    x-folder: clientes/clusters
  - name: Clientes - Endereços
    x-folder: clientes/enderecos
  - name: Clientes - Regras de frete dos clusters
    x-folder: clientes/clusters/regras-de-frete-dos-clusters
  - name: Configurações - Carrinhos abandonados
    x-folder: configuracoes/carrinhos-abandonados
  - name: Configurações - Checkout
    x-folder: configuracoes/checkout
  - name: Configurações - Credenciais da loja
    x-folder: configuracoes/credenciais-da-loja
  - name: Configurações - Dados da loja
    x-folder: configuracoes/dados-da-loja
  - name: Configurações - Fotos
    x-folder: configuracoes/fotos
  - name: Configurações - Integrações
    x-folder: configuracoes/integracoes
  - name: Configurações - IPs bloqueados
    x-folder: configuracoes/ips-bloqueados
  - name: Configurações - Overview
    x-folder: configuracoes/overview
  - name: Conteúdo - Páginas
    x-folder: conteudo/paginas
  - name: Conteúdo - Redirecionamentos
    x-folder: conteudo/redirecionamentos
  - name: Descontos
    x-folder: descontos
  - name: Leads
    x-folder: leads
  - name: Logística - Armazéns
    x-folder: logistica/armazens
  - name: Logística - Simular frete
    x-folder: logistica/simular-frete
  - name: Logística - CEP
    x-folder: logistica/cep
  - name: Logística - Embalagens
    x-folder: logistica/embalagens
  - name: Logística - Estoques
    description: >-
      O lojista pode ter um cadastro de múltiplos estoques onde ele pode
      associar posteriormente os SKUS com suas respectivas quantidades. Um
      exemplo prático é permitir que ele consiga trabalhar com estoques de
      fornecedores externos com diferentes prazos de entrega.
    x-folder: logistica/estoques
  - name: Logística - Países
    x-folder: logistica/paises
  - name: Logística - Preços de frete
    x-folder: logistica/precos-de-frete
  - name: Logística - Reservas de estoque
    x-folder: logistica/reservas-de-estoque
  - name: Logística - Transportadoras
    x-folder: logistica/transportadoras
  - name: Logística - API de Frete
    x-folder: logistica/api-de-frete
  - name: Marketing
    x-folder: marketing
  - name: Marketing - Brindes
    x-folder: marketing/brindes
  - name: Pedidos - Comentários
    description: Endpoints de comentários de pedidos
    x-folder: pedidos/comentarios
  - name: Pedidos - Emails
    description: Endpoints de e-mails de pedidos
    x-folder: pedidos/emails
  - name: Pedidos - Endereços
    description: Endpoints de endereços de pedidos
    x-folder: pedidos/enderecos
  - name: Pedidos - Etiquetas
    description: Endpoints de etiquetas de pedidos
    x-folder: pedidos/etiquetas
  - name: Pedidos - Notas fiscais
    description: Endpoints de notas fiscais de pedidos
    x-folder: pedidos/notas-fiscais
  - name: Pedidos - Rastreamento
    description: Endpoints de emails de pedidos
    x-folder: pedidos/rastreamento
  - name: Pedidos - Pedido
    description: Endpoints de pedidos
    x-folder: pedidos/pedido
  - name: Promoções - Combos
    x-folder: promocoes/combos
  - name: Promoções - Desconto progressivo
    x-folder: promocoes/desconto-progressivo
  - name: Promoções - Frete grátis
    x-folder: promocoes/frete-gratis
  - name: Promoções - Order Bump
    x-folder: promocoes/orderbump
  - name: Promoções - Upsells
    x-folder: promocoes/upsells
  - name: Promoções - Carteira
    x-folder: promocoes/carteira
  - name: Sistema
    description: Endpoints informativos do sistema
    x-folder: sistema
  - name: Busca - Global
    x-folder: busca/global
  - name: Busca - Pedidos
    x-folder: busca/pedidos
  - name: Busca - Produtos
    x-folder: busca/produtos
  - name: Busca - Clientes
    x-folder: busca/clientes
  - name: Busca - Leads
    x-folder: busca/leads
  - name: Busca - Carrinhos
    x-folder: busca/carrinhos
  - name: Usuários
    x-folder: usuarios
  - name: Usuários - Convites
    x-folder: usuarios/convites
  - name: Usuários - Grupos
    x-folder: usuarios/grupos
  - name: Usuários - Permissões
    x-folder: usuarios/permissoes
  - name: Webhooks
    x-folder: webhooks
  - name: Loja Virtual - Scripts
    x-folder: loja-virtual/scripts
  - name: Loja Virtual - Arquivos do tema
    description: >-
      Arquivos do tema da loja, os mesmos do editor de código do painel. As
      edições ficam no tema em preview até a publicação. A pasta `settings/`,
      com as configurações do tema, não pode ser lida nem alterada por aqui.
      Exige loja com acesso ao editor de código e a permissão
      `manage_open_code`. Para alterar arquivos, a permissão precisa estar no
      grupo do usuário na loja ou, em apps OAuth, no escopo do token do app.
      Usuários internos sem grupo na loja só leem. Limite de 60 requisições por
      minuto por usuário.
    x-folder: loja-virtual/arquivos-do-tema
  - name: Modulo - Recurso
    description: Modulo - Recurso
  - name: Marketplaces - Atributos
    description: Marketplaces - Atributos
  - name: Marketplaces - Anúncios
    description: Marketplaces - Anúncios
  - name: Links de Pagamento
    description: Links de Pagamento
  - name: Checkout - Contas bancárias
    description: Checkout - Contas bancárias
  - name: Checkout - Vendedores
    description: Checkout - Vendedores
  - name: Configurações - E-mails
    description: Configurações - E-mails
  - name: Configurações - Loja
    description: Configurações - Loja
  - name: Marketplaces - Categorias
    description: Marketplaces - Categorias
  - name: Marketplaces - Contas
    description: Marketplaces - Contas
  - name: Marketplaces - Lista de erros
    description: Marketplaces - Lista de erros
  - name: Marketplaces
    description: Marketplaces
  - name: Métricas - Cashback
    description: Métricas - Cashback
  - name: Promoções - Cashbacks
    description: Promoções - Cashbacks
  - name: Promoções - Cashback
    description: Promoções - Cashback
  - name: Promoções - Cupons de desconto
    description: Promoções - Cupons de desconto
  - name: Promoções - Produtos
    description: Promoções - Produtos
  - name: Filas
    description: Filas
paths:
  /{alias}/search/customers:
    get:
      tags:
        - Busca - Clientes
      summary: Listar Clientes retornados pela busca
      description: lista clientes retornados pela busca
      operationId: GetSearchCustomers
      parameters:
        - name: alias
          in: path
          description: Alias da loja
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Lista de clientes através da busca
          content:
            application/json:
              schema:
                properties:
                  data:
                    description: Clientes encontrados pela busca.
                    type: object
                    allOf:
                      - $ref: '#/components/schemas/Customer'
                      - $ref: '#/components/schemas/CustomerAdditionalResponse'
                type: object
        '400':
          description: Requisição inválida
        '404':
          description: URL inválida
components:
  schemas:
    Customer:
      title: Customer
      description: Representa um cliente
      properties:
        id:
          description: Identificador único do cliente.
          type: integer
        merchant_id:
          description: ID da loja à qual o cliente pertence.
          type: integer
        marketplace_id:
          description: >-
            ID do marketplace de origem do cliente, quando o cadastro vem de um
            marketplace.
          type: integer
        active:
          description: Indica se o cliente está ativo.
          type: boolean
        type:
          description: >-
            Tipo de pessoa do cliente: `f` para pessoa física, `j` para pessoa
            jurídica.
          type: string
        cluster_id:
          description: >-
            ID do cluster (grupo de clientes) ao qual o cliente está vinculado,
            quando houver.
          type: integer
        name:
          description: Nome do cliente.
          type: string
        first_name:
          description: Primeiro nome do cliente, derivado de `name`.
          type: string
        last_name:
          description: Sobrenome do cliente, derivado de `name`.
          type: string
        generic_name:
          description: >-
            Nome de exibição do cliente: o `name` para pessoa física e a
            `razao_social` para pessoa jurídica.
          type: string
        cpf:
          description: CPF do cliente, para pessoa física.
          type: string
        spreadsheet:
          description: >-
            Dados do cliente desnormalizados para exportação em planilha,
            retornados sob demanda via `include`.
          properties:
            data:
              description: Conjunto de dados do cliente usados na exportação em planilha.
              properties:
                brands:
                  description: >-
                    Marcas dos produtos comprados pelo cliente no último pedido,
                    separadas por vírgula.
                  type: string
                city:
                  description: Cidade do endereço do cliente.
                  type: string
                purchased_brands:
                  description: >-
                    Marcas dos produtos comprados pelo cliente no último pedido,
                    separadas por vírgula.
                  type: string
                last_order_date:
                  description: Data do último pedido do cliente.
                  properties:
                    date:
                      description: Data e hora do último pedido do cliente.
                      type: string
                      format: date-time
                    timezone:
                      description: Fuso horário da data do último pedido.
                      type: string
                    timezone_type:
                      description: >-
                        Tipo de representação do fuso horário (padrão interno de
                        data do PHP).
                      type: integer
                  type: object
                last_order_value:
                  description: Valor total do último pedido do cliente, em reais.
                  type: string
                purchased_categories:
                  description: >-
                    Categorias dos produtos comprados pelo cliente no último
                    pedido, separadas por vírgula.
                  type: string
                number:
                  description: Número do endereço do cliente.
                  type: string
                uf:
                  description: Unidade federativa (estado) do endereço do cliente.
                  type: string
                phone:
                  description: Telefone do cliente, com DDD e formatado.
                  type: string
                  example: (16) 98187-5668
                street:
                  description: Nome da rua do endereço do cliente.
                  type: string
                phone_number:
                  description: Número do telefone do cliente, sem o DDD.
                  type: string
                  example: '981875668'
                categories:
                  description: >-
                    Categorias dos produtos comprados pelo cliente no último
                    pedido, separadas por vírgula.
                  type: string
                neighborhood:
                  description: Bairro do endereço do cliente.
                  type: string
                complement:
                  description: Complemento do endereço do cliente.
                  type: string
                phone_code:
                  description: DDD do telefone do cliente.
                  type: string
                  example: '16'
              type: object
          type: object
        phone:
          description: Dados de telefone do cliente.
          properties:
            area_code:
              description: Código de área (DDD) do telefone.
              type: string
            full_number:
              description: Número completo do telefone, com DDD e sem formatação.
              type: string
            number:
              description: Número do telefone, sem o DDD.
              type: string
            formated_number:
              description: Número do telefone formatado para exibição.
              type: string
            whatsapp_link:
              description: Link para iniciar uma conversa no WhatsApp com o cliente.
              type: string
              format: uri
          type: object
        razao_social:
          description: Razão social do cliente, para pessoa jurídica.
          type: string
        cnpj:
          description: CNPJ do cliente, para pessoa jurídica.
          type: string
        state_registration:
          description: Inscrição estadual do cliente, para pessoa jurídica.
          type: string
        email:
          description: E-mail do cliente.
          type: string
          format: email
        password:
          description: >-
            Senha de acesso do cliente. Enviada apenas na criação ou
            atualização, nunca retornada.
          type: string
          writeOnly: true
        birthday:
          description: Data de nascimento do cliente.
          type: string
          format: date
        newsletter:
          description: Indica se o cliente aceitou receber a newsletter da loja.
          type: boolean
        whatsapp:
          description: Indica se o cliente aceitou receber mensagens no WhatsApp.
          type: boolean
        social_driver:
          description: >-
            Provedor de login social usado no cadastro do cliente (ex.: Google,
            Facebook), quando aplicável.
          type: string
        social_id:
          description: >-
            Identificador do cliente no provedor de login social, quando o
            cadastro veio de login social.
          type: integer
        ip:
          description: Endereço IP do cliente no momento do cadastro.
          type: string
          readOnly: true
        token:
          description: >-
            Token único do cliente, usado para autenticá-lo em ações como login
            automático.
          type: string
        utm_source:
          description: >-
            Origem da campanha de marketing (parâmetro UTM `utm_source`) que
            originou o cadastro do cliente.
          type: string
        utm_campaign:
          description: >-
            Nome da campanha de marketing (parâmetro UTM `utm_campaign`) que
            originou o cadastro do cliente.
          type: string
        notes:
          description: Observações internas sobre o cliente.
          type: string
        login_url:
          description: >-
            URL de login automático do cliente na loja, gerada a partir do seu
            `token`.
          type: string
          format: uri
        anonymized:
          description: >-
            Indica se os dados do cliente foram anonimizados por solicitação de
            exclusão (LGPD).
          type: boolean
      type: object
    CustomerAdditionalResponse:
      title: ''
      description: >-
        Recursos adicionais do cliente, retornados sob demanda via parâmetro
        `include`.
      properties:
        deletion_request:
          description: Solicitação de exclusão de dados do cliente (LGPD), quando houver.
          properties:
            data:
              description: Dados da solicitação de exclusão de dados do cliente.
              properties:
                pending_confirmation:
                  description: >-
                    Indica se a solicitação de exclusão ainda aguarda
                    confirmação do cliente.
                  type: boolean
                scheduled_date:
                  description: >-
                    Data agendada para a exclusão definitiva dos dados do
                    cliente.
                  type: string
                  format: date
              type: object
          type: object
        addresses:
          description: Endereços cadastrados pelo cliente.
          properties:
            data:
              description: Lista de endereços do cliente.
              type: array
              items:
                properties:
                  receiver:
                    description: Nome de quem recebe a entrega no endereço.
                    type: string
                  city:
                    description: Cidade do endereço.
                    type: string
                  full_address:
                    description: Endereço completo formatado.
                    type: string
                  zip_code:
                    description: CEP do endereço.
                    type: string
                  number:
                    description: Número do endereço.
                    type: string
                  uf:
                    description: Unidade federativa (estado) do endereço.
                    type: string
                  street:
                    description: Nome da rua do endereço.
                    type: string
                  id:
                    description: Identificador único do endereço.
                    type: integer
                  neighborhood:
                    description: Bairro do endereço.
                    type: string
                  customer_id:
                    description: ID do cliente dono do endereço.
                    type: integer
                  complement:
                    description: Complemento do endereço.
                    type: string
                  created_at:
                    $ref: '#/components/schemas/BaseTimestamp'
                  updated_at:
                    $ref: '#/components/schemas/BaseTimestamp'
                type: object
          type: object
        created_at:
          $ref: '#/components/schemas/BaseTimestamp'
        updated_at:
          $ref: '#/components/schemas/BaseTimestamp'
      type: object
    BaseTimestamp:
      description: >-
        Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário
        em que foi registrada.
      properties:
        date:
          description: Data e hora no formato YYYY-MM-DD H:MM:SS.
          type: string
          example: '2000-08-17 10:24:24'
        timezone_type:
          description: Número de representação do timezone.
          type: integer
          example: 3
        timezone:
          description: Fuso horário associado.
          type: string
          example: America/Sao_Paulo
      type: object
  securitySchemes:
    ApiToken:
      type: apiKey
      name: User-Token
      in: header
    ApiSecretKey:
      type: apiKey
      name: User-Secret-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.