Schema

Campos disponíveis na API de Leads

Esta referência descreve os campos públicos retornados pela API de Leads e delimita o que não faz parte do contrato público inicial.

Campos públicosJSONDados não expostos

Campos da resposta

Campo | Tipo | Nullable | Descrição | Exemplo

Campo	Tipo	Nullable	Descrição	Exemplo
id	string	Não	Identificador público do lead.	123
first_name	string	Sim	Primeiro nome do lead.	Maria
last_name	string	Sim	Sobrenome do lead.	Silva
full_name	string	Sim	Nome completo consolidado.	Maria Silva
email	string	Sim	E-mail do lead quando disponível.	maria@example.com
phone	string	Sim	Telefone em formato numérico.	5545999999999
origin	string	Sim	Origem pública do lead.	MANUAL
status	boolean	Sim	Status ativo do lead quando aplicável.	true
subscribed	boolean	Sim	Indica inscrição ou vínculo ativo quando aplicável.	true
created_at	datetime	Não	Data de criação do registro.	2026-05-06T12:00:00Z
updated_at	datetime	Não	Data da última atualização pública.	2026-05-06T12:30:00Z
deleted	boolean	Não	Indica remoção ou inativação pública.	false
deleted_at	datetime	Sim	Data de remoção quando existir.	null
last_bought	datetime	Sim	Última compra registrada quando aplicável.	null
total_orders	number	Não	Quantidade total de pedidos quando aplicável.	0
lead_linkedin_url	string	Sim	URL pública de LinkedIn quando disponível.	null
lead_role	string	Sim	Cargo ou papel público do lead.	null
lead_type	string	Sim	Tipo público de lead quando classificado.	null
lead_area	string	Sim	Área funcional pública do lead.	null

Identificação

id, first_name, last_name e full_name ajudam o destino a identificar o lead e montar exibições legíveis para usuários internos.

Contato

email e phone são campos públicos de contato quando disponíveis. O destino deve validar formato e política de uso antes de acionar qualquer canal.

Status e datas

status, subscribed, created_at e updated_at ajudam a controlar sincronização, atualização e leitura operacional do registro.

Prospecção

lead_linkedin_url, lead_role, lead_type e lead_area ajudam a contextualizar o lead quando esses dados públicos estiverem disponíveis.

Remoção ou inativação

deleted e deleted_at indicam remoção ou inativação quando aplicável. O sistema externo decide como refletir essa informação no destino.

Campos não expostos

Dados como documento, aniversário, renda estimada, endereço completo, custos, auditoria interna, tokens e payloads externos não são parte do contrato público inicial.

Também não são prometidos atributos internos, IDs externos de integrações, secrets, dados internos de prospecção ou detalhes de banco e infraestrutura.
Se um destino precisar de dado não listado aqui, trate como fora do contrato público documentado.

Exemplo de JSON

{
  "data": [
    {
      "id": "123",
      "first_name": "Maria",
      "last_name": "Silva",
      "full_name": "Maria Silva",
      "email": "maria@example.com",
      "phone": "5545999999999",
      "origin": "MANUAL",
      "status": true,
      "subscribed": true,
      "created_at": "2026-05-06T12:00:00Z",
      "updated_at": "2026-05-06T12:30:00Z",
      "deleted": false,
      "deleted_at": null,
      "last_bought": null,
      "total_orders": 0,
      "lead_linkedin_url": null,
      "lead_role": null,
      "lead_type": null,
      "lead_area": null
    }
  ],
  "page_info": {
    "next_cursor": null,
    "has_more": false
  }
}