--- title: "Listar Clientes retornados pela busca" method: GET path: "/{alias}/search/customers" tags: ["Busca - Clientes"] --- # Listar Clientes retornados pela busca `GET /{alias}/search/customers` ## Request - Base URL: `https://api.dooki.com.br/v2` - URL: `https://api.dooki.com.br/v2/{alias}/search/customers` - Auth: API key in header `User-Token` and API key in header `User-Secret-Key` lista clientes retornados pela busca ## Path parameters - `alias` string, required ## Response `200` Lista de clientes através da busca - object - `data` object: Recursos adicionais do cliente, retornados sob demanda via parâmetro `include`. - `id` integer: Identificador único do cliente. - `merchant_id` integer: ID da loja à qual o cliente pertence. - `marketplace_id` integer: ID do marketplace de origem do cliente, quando o cadastro vem de um marketplace. - `active` boolean: Indica se o cliente está ativo. - `type` string: Tipo de pessoa do cliente: `f` para pessoa física, `j` para pessoa jurídica. - `cluster_id` integer: ID do cluster (grupo de clientes) ao qual o cliente está vinculado, quando houver. - `name` string: Nome do cliente. - `first_name` string: Primeiro nome do cliente, derivado de `name`. - `last_name` string: Sobrenome do cliente, derivado de `name`. - `generic_name` string: Nome de exibição do cliente: o `name` para pessoa física e a `razao_social` para pessoa jurídica. - `cpf` string: CPF do cliente, para pessoa física. - `spreadsheet` object: Dados do cliente desnormalizados para exportação em planilha, retornados sob demanda via `include`. - `data` object: Conjunto de dados do cliente usados na exportação em planilha. - `brands` string: Marcas dos produtos comprados pelo cliente no último pedido, separadas por vírgula. - `city` string: Cidade do endereço do cliente. - `purchased_brands` string: Marcas dos produtos comprados pelo cliente no último pedido, separadas por vírgula. - `last_order_date` object: Data do último pedido do cliente. - `date` string, date-time: Data e hora do último pedido do cliente. - `timezone` string: Fuso horário da data do último pedido. - `timezone_type` integer: Tipo de representação do fuso horário (padrão interno de data do PHP). - `last_order_value` string: Valor total do último pedido do cliente, em reais. - `purchased_categories` string: Categorias dos produtos comprados pelo cliente no último pedido, separadas por vírgula. - `number` string: Número do endereço do cliente. - `uf` string: Unidade federativa (estado) do endereço do cliente. - `phone` string: Telefone do cliente, com DDD e formatado. - `street` string: Nome da rua do endereço do cliente. - `phone_number` string: Número do telefone do cliente, sem o DDD. - `categories` string: Categorias dos produtos comprados pelo cliente no último pedido, separadas por vírgula. - `neighborhood` string: Bairro do endereço do cliente. - `complement` string: Complemento do endereço do cliente. - `phone_code` string: DDD do telefone do cliente. - `phone` object: Dados de telefone do cliente. - `area_code` string: Código de área (DDD) do telefone. - `full_number` string: Número completo do telefone, com DDD e sem formatação. - `number` string: Número do telefone, sem o DDD. - `formated_number` string: Número do telefone formatado para exibição. - `whatsapp_link` string, uri: Link para iniciar uma conversa no WhatsApp com o cliente. - `razao_social` string: Razão social do cliente, para pessoa jurídica. - `cnpj` string: CNPJ do cliente, para pessoa jurídica. - `state_registration` string: Inscrição estadual do cliente, para pessoa jurídica. - `email` string, email: E-mail do cliente. - `password` string: Senha de acesso do cliente. Enviada apenas na criação ou atualização, nunca retornada. - `birthday` string, date: Data de nascimento do cliente. - `newsletter` boolean: Indica se o cliente aceitou receber a newsletter da loja. - `whatsapp` boolean: Indica se o cliente aceitou receber mensagens no WhatsApp. - `social_driver` string: Provedor de login social usado no cadastro do cliente (ex.: Google, Facebook), quando aplicável. - `social_id` integer: Identificador do cliente no provedor de login social, quando o cadastro veio de login social. - `ip` string: Endereço IP do cliente no momento do cadastro. - `token` string: Token único do cliente, usado para autenticá-lo em ações como login automático. - `utm_source` string: Origem da campanha de marketing (parâmetro UTM `utm_source`) que originou o cadastro do cliente. - `utm_campaign` string: Nome da campanha de marketing (parâmetro UTM `utm_campaign`) que originou o cadastro do cliente. - `notes` string: Observações internas sobre o cliente. - `login_url` string, uri: URL de login automático do cliente na loja, gerada a partir do seu `token`. - `anonymized` boolean: Indica se os dados do cliente foram anonimizados por solicitação de exclusão (LGPD). - `deletion_request` object: Solicitação de exclusão de dados do cliente (LGPD), quando houver. - `data` object: Dados da solicitação de exclusão de dados do cliente. - `pending_confirmation` boolean: Indica se a solicitação de exclusão ainda aguarda confirmação do cliente. - `scheduled_date` string, date: Data agendada para a exclusão definitiva dos dados do cliente. - `addresses` object: Endereços cadastrados pelo cliente. - `data` object[]: Lista de endereços do cliente. - `receiver` string: Nome de quem recebe a entrega no endereço. - `city` string: Cidade do endereço. - `full_address` string: Endereço completo formatado. - `zip_code` string: CEP do endereço. - `number` string: Número do endereço. - `uf` string: Unidade federativa (estado) do endereço. - `street` string: Nome da rua do endereço. - `id` integer: Identificador único do endereço. - `neighborhood` string: Bairro do endereço. - `customer_id` integer: ID do cliente dono do endereço. - `complement` string: Complemento do endereço. - `created_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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. - `created_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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`: URL inválida ## Changes - **2026-11-03** `bbafb577e11c`: 1 info - endpoint added [Operation history](https://skmtc.dev/yampi/apis/yampi-api/changes/:alias/search/customers/get.md) --- [API](https://skmtc.dev/yampi/apis/yampi-api.md) - [All operations](https://skmtc.dev/yampi/apis/yampi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yampi/apis/yampi-api/revisions/74739ec8876f?raw)