Buscar Lead por Telefone

curl --request GET \
  --url https://api.superlead.app/v1/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.superlead.app/v1/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "lead_0b5f8a3e-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
  "name": "João Silva",
  "phone": "+5511999999999",
  "source": "Meta Ads",
  "channel": "WhatsApp",
  "entry_point": "ctwa",
  "funnel_stage": "1º Contato",
  "document": "123.456.789-01",
  "document_type": "cpf",
  "cep": "01310-100",
  "address": "Av. Paulista",
  "address_number": "1000",
  "address_complement": null,
  "neighborhood": "Bela Vista",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "created_at": "2026-06-01T12:00:00.000Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "The request body is invalid.",
    "request_id": "req_01J9X7K2M3N4P5Q6R7S8T9V0W1",
    "details": [
      {
        "path": "to",
        "message": "Required"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "Missing or invalid API key. Send it as 'Authorization: Bearer sk_...'.",
    "request_id": "req_01J9X7K2M3N4P5Q6R7S8T9V0W1"
  }
}

{
  "error": {
    "code": "lead_not_found",
    "message": "No lead matches this recipient in your company. The API only messages existing leads.",
    "request_id": "req_01J9X7K2M3N4P5Q6R7S8T9V0W1"
  }
}

Leads

Buscar Lead por Telefone

Busca um lead da sua empresa pelo telefone e retorna o cadastro completo — o mesmo recurso de GET /v1/leads/{id}.

Aceita E.164 (+5511999999999) ou apenas dígitos (5511999999999).
Em query string, codifique o + como %2B — um + cru vira espaço. Alternativa: envie só os dígitos.
Números brasileiros: a busca testa automaticamente a variação do nono dígito, então funciona com ou sem o 9 após o DDD.

Use antes de criar (POST /v1/leads) para não duplicar, e para descobrir o id (lead_...) de um lead que você só conhece pelo telefone.

GET

leads

Buscar Lead por Telefone

curl --request GET \
  --url https://api.superlead.app/v1/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.superlead.app/v1/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "lead_0b5f8a3e-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
  "name": "João Silva",
  "phone": "+5511999999999",
  "source": "Meta Ads",
  "channel": "WhatsApp",
  "entry_point": "ctwa",
  "funnel_stage": "1º Contato",
  "document": "123.456.789-01",
  "document_type": "cpf",
  "cep": "01310-100",
  "address": "Av. Paulista",
  "address_number": "1000",
  "address_complement": null,
  "neighborhood": "Bela Vista",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "created_at": "2026-06-01T12:00:00.000Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "The request body is invalid.",
    "request_id": "req_01J9X7K2M3N4P5Q6R7S8T9V0W1",
    "details": [
      {
        "path": "to",
        "message": "Required"
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "Missing or invalid API key. Send it as 'Authorization: Bearer sk_...'.",
    "request_id": "req_01J9X7K2M3N4P5Q6R7S8T9V0W1"
  }
}

{
  "error": {
    "code": "lead_not_found",
    "message": "No lead matches this recipient in your company. The API only messages existing leads.",
    "request_id": "req_01J9X7K2M3N4P5Q6R7S8T9V0W1"
  }
}

Authorizations

Authorization

string

header

required

Chave de API da sua empresa (sk_...). Crie no painel Superlead em Integrações → API e envie em toda chamada como Authorization: Bearer sk_.... Veja Autenticação.

Query Parameters

phone

string

required

Telefone em E.164 (%2B5511999999999 na query) ou só dígitos (5511999999999). A variação do nono dígito BR é tratada automaticamente.

Response

Lead encontrado — cadastro completo.

string

Id do lead no Superlead (lead_...). Estável — use nas demais chamadas.

Example:

"lead_0b5f8a3e-1a2b-3c4d-5e6f-7a8b9c0d1e2f"

name

string | null

Nome do lead.

Example:

"João Silva"

phone

string | null

Telefone em E.164. null para leads sem telefone exposto (username do WhatsApp).

Example:

"+5511999999999"

source

string | null

Origem do lead exibida no painel.

Example:

"Meta Ads"

channel

string | null

Canal de origem.

Example:

"WhatsApp"

entry_point

string | null

Ponto de entrada da conversão.

Example:

"ctwa"

funnel_stage

string | null

Nome da etapa atual do funil. Para mover, use PUT /v1/leads/{id}/stage.

Example:

"1º Contato"

document

string | null

CPF ou CNPJ do lead.

Example:

"123.456.789-01"

document_type

enum<string> | null

Tipo do documento.

Available options:

cpf,

cnpj

Example:

"cpf"

cep

string | null

CEP do endereço.

Example:

"01310-100"

address

string | null

Logradouro.

Example:

"Av. Paulista"

address_number

string | null

Número.

Example:

"1000"

address_complement

string | null

Complemento.

Example:

"Conjunto 51"

neighborhood

string | null

Bairro.

Example:

"Bela Vista"

city

string | null

Cidade.

Example:

"São Paulo"

state

string | null

Estado (UF).

Example:

"SP"

country

string | null

País.

Example:

"BR"

created_at

string<date-time>

Data de criação do lead (ISO 8601, UTC).

Example:

"2026-06-01T12:00:00.000Z"

Introdução

WhatsApp

Leads

Funil

Buscar Lead por Telefone

Authorizations

Query Parameters

Response