v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Motivos de Cancelamento de Lead

Retorna os Motivos de Cancelamento do Lead

🔒 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 de motivos de cancelamento de lead. A consulta é realizada através dos dados enviados na URL, podendo passar os seguintes parâmetros: pagina, registros_por_pagina, detalhamento e exibir_inativos.

get/v1/comercial/motivos-cancelamento-lead

Query parameters

paginainteger

Página que deseja visualizar os registros

Example:1
registros_por_paginainteger

Limite de itens exibido por página

Example:30
detalhamentoboolean

Exibir vinculos com situações

Example:true
exibir_inativosboolean

Exibir motivos inativos

Example:true

Headers

emailstring required
Example:email@email.com
tokenstring required
Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Response

Operação realizada com sucesso.

paginainteger

Página atual.

registrosinteger

Total de registro na página atual.

total_de_registrosinteger

Total de registro.

total_de_paginasinteger

Total de páginas.

offsetinteger

Início da busca.

Example response

{
  "pagina": 1,
  "registros": 30,
  "total_de_registros": 60,
  "total_de_paginas": 2,
  "dados": {
    "id": 1,
    "nome": "Motivo x",
    "explicacao_obrigatoria": "S",
    "motivo_padrao": "N",
    "ativo": "S",
    "situacoes": {
      "id": 1,
      "nome": "Situacao x"
    }
  }
}