---
title: "Busca Cliente por E-mail"
method: GET
path: "/v1/customers/email"
tags: ["Clientes"]
---

# Busca Cliente por E-mail

`GET /v1/customers/email`

## Request

- Base URL: `https://api-sandbox.kobana.com.br`
- URL: `https://api-sandbox.kobana.com.br/v1/customers/email`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kobana/apis/cobran-as/docs/v1/customers/email/get.ts> (a function with typed inputs; its response is checked against the schema)

Visualizar um cliente buscando por e-mail.

## Query parameters

- `q` string, required

## Headers

- `User-Agent` string

## Response `200`

Cliente encontrado

- CustomerObject
  - `id` integer: ID
  - `external_code` string, nullable: Código Externo
  - `cnpj_cpf` string: CPF/CNPJ
  - `person_name` string, required: Nome ou Razão Social
  - `contact_person` string, nullable: Pessoa de Contato (quando Empresa)
  - `nickname` string, nullable: Apelido ou Nome Fantasia do Pagador
  - `birthday` string, date, nullable: Data de Nascimento
  - `email` string, email: E-mail principal
  - `email_cc` string, email: E-mail alternativo
  - `address` string, required: Endereço
  - `address_complement` string, nullable: Complemento do Endereço
  - `address_number` string: Número
  - `neighborhood` string, required: Bairro
  - `zipcode` string, required: CEP (formato 99999999)
  - `state` string: Estado
  - `city_name` string, required: Cidade (Nome deve estar correto e completo)
  - `phone_number` string, nullable: Telefone (com DDD, DDI é opcional)
  - `mobile_local_code` string, nullable: DDD do Celular
  - `mobile_number` string, nullable: Celular
  - `ignore_email` boolean, nullable: Nunca enviar e-mail para este cliente
  - `ignore_sms` boolean, nullable: Nunca enviar SMS para este cliente
  - `ignore_whatsapp` boolean, nullable: Nunca enviar Whatsapp para este cliente
  - `notes` string, nullable: Observações
  - `tags` string[], nullable: Tags associadas ao registro
  - `tag_list` string, nullable: Tags associadas ao registro
  - `custom_data` object, nullable: Hash com chave e valor no formato JSON.
  - `created_via_api` boolean, nullable: Indica se o registro foi criado por API
  - `created_at` string, date-time, nullable: Data e hora de criação do registro
  - `updated_at` string, date-time, nullable: Data e hora da última atualização do registro

## Other responses

- `401`: Falha de autenticação. Token inválido
- `403`: Falha de permissão. Você não tem o Scope obrigatório para essa chamada.
- `404`: Cliente não encontrado

---

[API](https://skmtc.dev/kobana/apis/cobran-as.md) - [All operations](https://skmtc.dev/kobana/apis/cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/kobana/apis/cobran-as/revisions/728c362ec4d7?raw)