v1
latestOpenAPI 3.0.02026-07-264636241.7 MBRetorna leads
🔒 Autenticação necessária
Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)
A interface viabiliza a consulta dos leads. Pode ser enviado como parâmetro na URL os seguintes campos: idlead, email ou telefone (cada parâmetro deve ser usado exclusivamente). Os leads exibidos são apenas os quais o usuário autenticado têm acesso.
Query parameters
Determina que serão retornados apenas os leads cuja situação no workflow é diferente daquelas com flag "cancelada", "vencida" e "fim"
Determina que serão retornados apenas os leads que possuem tarefas com data posterior à que a requisição é feita
Determina que serão retornados apenas os leads que possuem tarefas com data inferior à que a requisição é feita
Limite de itens no conteúdo da resposta. Utiliza a configuração "Limita a quantidade máxima de registros que podem ser solicitados nas listagens".
Offset do início dos resultados (Não deve ser utilizado quando especificado um lead).
Determina que serão retornados apenas os leads que possuem a situação no workflow à que a requisição é feita
Headers
Response
Operação realizada com sucesso.
Example response
{
"codigo": 200,
"total": 12340,
"leads": [
{
"idlead": 193,
"gestor": {
"id": 217,
"nome": "José da Silva",
"email": "josedasilva@souexemplo.com"
},
"imobiliaria": {
"id": 2,
"nome": "Imobiliária de Imóveis"
},
"corretor": {
"id": 48,
"nome": "João dos Santos",
"email": "joaodossantos@souexemplo.com"
},
"situacao": {
"id": 1,
"nome": "Novo Lead"
},
"nome": "Maria das Neves",
"email": "mariadasneves@email.com",
"telefone": "+55(79) 99999-9999",
"score": 5,
"data_cad": "2020-03-19 18:12:05",
"midia_principal": "Facebook Ads",
"documento_tipo": "cpf",
"documento": "76789571574",
"sexo": "F",
"renda_familiar": "3500.00",
"valor_negocio": "150000.00",
"cep": "49030420",
"numero": "302",
"bairro": "Farolândia",
"complemento": "Condominio Vale do Ribeiro",
"estado": "Sergipe",
"cidade": "Aracaju",
"profissao": "Enfermeiro(a)",
"origem": "Facebook",
"data_reativacao": "2021-08-07 10:20:25",
"data_vencimento": "2021-08-07 11:20:25",
"ultima_data_conversao": "2021-08-07 11:20:25",
"codigointerno": 16,
"possibilidade_venda": 1,
"empreendimento": [
{
"id": 3,
"nome": "Empreendimento Vila Verde"
}
],
"midias": [
"Facebook Ads"
],
"tags": [
"tag-do-lead"
],
"data_cancelamento": "2021-08-12 16:20:25",
"motivo_cancelamento": {
"id": 1,
"nome": "Cancelamento em lote",
"descricao": "Lead foi cancelado em lote"
},
"submotivo_cancelamento": {
"nome": "Cancelamento em lote"
},
"data_venda": "2021-08-15 18:50:25",
"campos_adicionais": [
{
"slug": "cf_renda_customizada",
"valor": "Entre R$5.000,00 e R$10.000,00"
}
],
"interacao": [
{
"id": 3254,
"descricao": "Tentei entrar em contato e o cliente não atendeu.",
"data_cad": "2021-08-12 16:15:00"
}
],
"tarefa": [
{
"id": 254,
"nome": "Enviar mensagem para o lead",
"descricao": "Tentar contato com lead por mensagem",
"data_cad": "2021-08-12 11:15:00",
"data": "2021-08-12 16:10:00",
"data_conclusao": "2021-08-13 14:10:00",
"data_cancelamento": "2021-08-12 16:14:47"
}
],
"valor_venda": "150000.00",
"autor_ultima_alteracao": "gestorultimaalteracao@email.com",
"qtde_simulacoes_associadas": 10,
"qtde_reservas_associadas": 10,
"link_interacoes": "https://{URL_CLIENTE}/gestor/relatorios/interacoes/html?q[1|l.idlead]=1",
"link_simulacoes": "https://{URL_CLIENTE}/gestor/relatorios/simulacao/html?q[1|l.idlead]=1",
"link_reservas": "https://{URL_CLIENTE}/gestor/relatorios/reservas/html?q[1|l.idlead]=1",
"link_interesses": "https://{URL_CLIENTE}/gestor/comercial/leads/1/administrar",
"idrd_station": "ttet525t-6759-4ba7-a5t5-c18t0c5b9tta",
"link_rdstation": "https://app.rdstation.com.br/leads/public/ttet525t-6759-4ba7-a5t5-c18t0c5b9tta"
}
]
}