Get active clients

Buscar Clientes Ativos

Descrição

Este endpoint retorna a lista de clientes com contratos ativos, incluindo informações sobre contratos atuais e futuros. É útil para acompanhamento da base ativa, planejamento de retenção e análise de contratos vigentes.

🔑 Parâmetros da Requisição

Este endpoint não possui parâmetros.

📤 Estrutura da Resposta

A resposta retorna uma lista de clientes ativos com detalhes sobre contratos atuais e futuros.

CampoTipoDescrição
idFilialint32Identificador da filial.
filialstringNome da filial.
idClienteint32Identificador do cliente.
nomeCompletostringNome completo do cliente.
telefonestringTelefone do cliente.
emailstringEmail do cliente.
idClienteContratoAtivoint32ID do contrato ativo do cliente.
contratoAtivostringNome ou descrição do contrato ativo.
dtInicioContratoAtivostring(date-time)Data de início do contrato ativo.
dtFimContratoAtivostring(date-time)Data de término do contrato ativo.
idClienteContratoFuturoint32ID do contrato futuro do cliente, se houver.
contratoFuturostringNome ou descrição do contrato futuro, se houver.
dtInicioContratoFuturostring(date-time)Data de início do contrato futuro, se houver.
dtFimContratoFuturostring(date-time)Data de término do contrato futuro, se houver.

✅ Exemplo de Resposta

[
  {
    "idFilial": 10,
    "filial": "Filial Centro",
    "idCliente": 12345,
    "nomeCompleto": "João da Silva",
    "telefone": "+5511999999999",
    "email": "[email protected]",
    "idClienteContratoAtivo": 789,
    "contratoAtivo": "Plano Anual Premium",
    "dtInicioContratoAtivo": "2025-01-01T00:00:00Z",
    "dtFimContratoAtivo": "2025-12-31T23:59:59Z",
    "idClienteContratoFuturo": 790,
    "contratoFuturo": "Plano Anual VIP",
    "dtInicioContratoFuturo": "2026-01-01T00:00:00Z",
    "dtFimContratoFuturo": "2026-12-31T23:59:59Z"
  }
]
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!