---
title: "Retorna leads"
method: GET
path: "/v1/comercial/leads"
tags: ["Leads"]
---

# Retorna leads

`GET /v1/comercial/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)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-apis-cvcrm-email-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

- `idlead` integer
- `email` string
- `telefone` string
- `idcorretor` integer
- `ativo` boolean
- `tarefasPendentes` boolean
- `tarefasVencidas` boolean
- `limit` string
- `offset` string
- `idsituacao` integer

## Headers

- `email` string, required
- `token` string, required

## Response `200`

Operação realizada com sucesso.

- RetornarLeadSucesso
  - `codigo` integer — Código de retorno da operação.
  - `total` integer — Total de resultados.
  - `limit` string — Limite de itens no conteúdo da resposta.
  - `offset` string — Offset do início dos resultados.
  - `totalConteudo` integer — Total de itens no conteúdo na resposta
  - `leads` object[]
    - `idlead` integer
    - `gestor` object
      - `id` integer
      - `nome` string
      - `email` string
    - `imobiliaria` object
      - `id` integer
      - `nome` string
    - `corretor` object
      - `id` integer
      - `nome` string
      - `email` string
    - `situacao` object
      - `id` integer
      - `nome` string
    - `nome` string
    - `email` string
    - `telefone` string
    - `score` integer
    - `data_cad` string
    - `midia_principal` string
    - `documento_tipo` string
    - `documento` string
    - `sexo` string
    - `renda_familiar` string
    - `valor_negocio` string
    - `cep` string
    - `numero` string
    - `bairro` string
    - `complemento` string
    - `estado` string
    - `cidade` string
    - `profissao` string
    - `origem` string
    - `data_reativacao` string
    - `data_vencimento` string
    - `ultima_data_conversao` string
    - `codigointerno` integer
    - `possibilidade_venda` integer
    - `empreendimento` object[]
      - `id` integer
      - `nome` string
    - `midias` string[]
    - `tags` string[]
    - `data_cancelamento` string
    - `motivo_cancelamento` object
      - `id` integer
      - `nome` string
      - `descricao` string
    - `submotivo_cancelamento` object
      - `nome` string
    - `data_venda` string
    - `campos_adicionais` object[]
      - `slug` string
      - `valor` string
    - `interacao` object[]
      - `id` integer
      - `descricao` string
      - `data_cad` string
    - `tarefa` object[]
      - `id` integer
      - `nome` string
      - `descricao` string
      - `data_cad` string
      - `data` string
      - `data_conclusao` string
      - `data_cancelamento` string
    - `valor_venda` string
    - `autor_ultima_alteracao` string
    - `qtde_simulacoes_associadas` integer
    - `qtde_reservas_associadas` integer
    - `link_interacoes` string
    - `link_simulacoes` string
    - `link_reservas` string
    - `link_interesses` string
    - `idrd_station` string
    - `link_rdstation` string

## Other responses

- `400` — Requisição Incorreta! Os dados (idlead, email, telefone ou idcorretor) não correspondem a nenhum lead no sistema ou não foram informados.
- `401` — Sem autorização. Pode ser devido a dados de acesso incorretos ou lead em atendimento por terceiros.
- `500` — Erro interno geral. Deve ser verificado com o suporte.

---

[API](https://skmtc.net/cvcrm/apis/clientes.md) · [All operations](https://skmtc.net/cvcrm/apis/clientes/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cvcrm/clientes/versions/42bf5add8bf3/schema)