v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Leads

Retorna listagem de leads com data de vencimento

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Retorna a listagem paginada de leads que possuem data de vencimento definida, excluindo leads cujas situações de workflow estejam com fim, cancelada ou vencida. Os resultados podem ser filtrados por lead específico e ordenados por data de vencimento ou data de cadastro.

get/v3/comercial/leads/vencimento

Query parameters

paginainteger

Example:1

Número da página desejada. Padrão: 1.

registros_por_paginainteger

Example:50

Quantidade de registros por página. Máximo: 100. Padrão: 50.

sort'dataVencimento' | 'dataCad'

Example:dataVencimento

Campo para ordenação dos resultados. Valores aceitos: dataVencimento (data de vencimento do lead) ou dataCad (data de cadastro). Padrão: dataCad.

order'ASC' | 'DESC'

Example:ASC

Direção da ordenação. Valores aceitos: ASC ou DESC.

idleadinteger

Example:123

Filtra pelo ID de um lead específico.

Response

Listagem de leads com vencimento retornada com sucesso.

statusstring

codeinteger

Example response

{
  "status": "success",
  "code": 200,
  "data": {
    "total": 150,
    "pagina": 1,
    "registros_por_pagina": 50,
    "dados": [
      {
        "idlead": 123,
        "nome": "João Silva",
        "email": "joao.silva@email.com",
        "telefone": "11999999999",
        "data_vencimento": "2024-03-15 10:00:00",
        "data_cad": "2024-01-01 09:30:00",
        "idsituacao": 2,
        "nome_situacao": "Em atendimento"
      }
    ]
  }
}