Liftflex
HomeRecursosAPI
REST API v2

API de Integração Liftflex

Conecte ERPs, portais, BI e automações ao Liftflex via REST — chamados, clientes, contratos, financeiro, boletos e WhatsApp.

Documentação Swagger ↗Solicitar API Key
  • Documentação Swagger interativa — teste endpoints no navegador.
  • Consulta de chamados, clientes, contratos e títulos financeiros.
  • Boletos por ID ou CPF/CNPJ do pagador.
  • Webhook de retorno de boleto enviado via WhatsApp.
  • Validação de telefone vinculado a CPF/CNPJ para cobrança.

A API REST v2 do Liftflex expõe dados operacionais e financeiros da conservadora em JSON. Autentique com API Key, consulte a documentação interativa Swagger e integre sistemas externos sem duplicar cadastros.

Base URL

https://app.liftflex.com/Liftflex_API/rest/v2

Listar chamados do período

GET https://app.liftflex.com/Liftflex_API/rest/v2/GetChamadoLista?x-api-key=SUA_API_KEY&DataCadastroInicio=2026-07-01&DataCadastroFim=2026-07-14

Buscar cliente

GET https://app.liftflex.com/Liftflex_API/rest/v2/GetClientes?Key=SUA_API_KEY&ValorProcura=CONDOMINIO

Contas a receber por vencimento

GET https://app.liftflex.com/Liftflex_API/rest/v2/GetContasReceberByVencimento?Key=SUA_API_KEY&DataInicial=2026-07-01&DataFinal=2026-07-31

Callback boleto WhatsApp

POST https://app.liftflex.com/Liftflex_API/rest/v2/UpdateWhatsAppBoletoMessage?BoletoId=123&TenantId=1
Content-Type: application/json

{"Status": true, "Message": "Enviado com sucesso"}

Autenticação

Endpoints protegidos por API Key ou TenantId. Consulte a documentação Swagger para parâmetros obrigatórios de cada rota.

Parâmetro Key

A maioria dos endpoints exige o parâmetro de query Key com a API Key da empresa Liftflex — a mesma utilizada no Painel Operacional WhatsApp.

Header x-api-key

O endpoint GetChamadoLista utiliza o parâmetro x-api-key em vez de Key para autenticação.

TenantId

Endpoints de boleto (GetBoletoById, GetBoletoByCprf, UpdateWhatsAppBoletoMessage) exigem TenantId da empresa.

Operação — Chamados

Consulte chamados abertos, finalizados ou filtrados por técnico, prédio, área e período.

MétodoEndpointDescriçãoAuth
GET/GetChamadoLista

x-api-key, ChamadoId?, Situacao?, DataCadastroInicio?, DataCadastroFim?, Tecnico?, AreaId?, PredioId?

Lista chamados com filtros opcionais por situação, datas, técnico, área e prédio.x-api-key
GET/GetChamadoById

Key, ChamadoId, TenantId

Retorna detalhes de um chamado específico, incluindo PDF quando disponível.Key

Cadastros — Clientes e produtos

Pesquise clientes, contatos, empresas e produtos cadastrados no ERP.

MétodoEndpointDescriçãoAuth
GET/GetClientes

Key, ValorProcura

API para pesquisar clientes por valor de procura (nome, documento, etc.).Key
GET/GetClienteByPessoaId

Key, PessoaId

Retorna cliente pelo identificador de pessoa.Key
GET/GetContatoCliente

Key, ClienteId

Lista contatos (e-mail e telefone) vinculados a um cliente.Key
GET/GetEmpresa

Key

API para pesquisar empresas/unidades cadastradas.Key
GET/GetProdutos

Key, ValorProcura

API para pesquisar produtos do almoxarifado/catálogo.Key

Contratos

Consulte contratos de manutenção por ID ou por cliente.

MétodoEndpointDescriçãoAuth
GET/GetContratoById

Key, ContratoId

Retorna contrato pelo identificador.Key
GET/GetContratoByClienteId

Key, ClienteId

Lista contratos vinculados a um cliente.Key

Financeiro — Contas a pagar e receber

Integre conciliação, cobrança e relatórios financeiros externos.

MétodoEndpointDescriçãoAuth
GET/GetContasReceberById

Key, ContasReceberId

Título a receber por ID.Key
GET/GetContasReceberByVencimento

Key, DataInicial, DataFinal

Títulos a receber filtrados por intervalo de vencimento.Key
GET/GetContasReceberByFinanceiroSituacao

Key, FinanceiroSituacao, Help

Títulos a receber por situação financeira. Use Help=help para listar opções.Key
GET/GetContasPagarById

Key, ContasPagarId

Título a pagar por ID.Key
GET/GetContasPagarByVencimento

Key, DataInicioVencimento, DataFimVencimento

Títulos a pagar por intervalo de vencimento.Key
GET/GetContasPagarBySituacao

Key, FinanceiroSituacaoId, Help?

Títulos a pagar por situação. Use Help=help para listar opções.Key

Boletos e WhatsApp

Consulta de boletos e callback de mensagens enviadas pelo 99chat.

MétodoEndpointDescriçãoAuth
GET/GetBoletoById

Id, TenandId

Retorna boleto pelo identificador.TenantId
GET/GetBoletoByCprf

Cprf, TenantId

Retorna boleto pelo CPF/CNPJ do pagador.TenantId
GET/ValidarCprfTelefone

TenantId, Cprf, Telefone

Valida se telefone está vinculado ao CPF/CNPJ para envio de cobrança via WhatsApp.Key
POST/UpdateWhatsAppBoletoMessage

BoletoId, TenantId, body: WhatsAppBoletoResponse

Registra retorno de envio de boleto pelo WhatsApp (Status e Message no body JSON).TenantId

Schemas de resposta

A documentação Swagger descreve os modelos JSON retornados — estruturas tipadas para chamados, clientes, financeiro e boletos.

  • Chamados — lista e detalhe de chamados com defeitos, fotos e PDF
  • GetClienteStruct / ClienteStruct — dados cadastrais do cliente
  • GetContratoStruct — contratos de manutenção
  • GetFinanceiroCRStruct / GetFinanceiroCPStruct — contas a receber e pagar
  • RetornoBoleto / BoletoResponse — dados de boleto
  • WhatsAppBoletoResponse — Status (boolean) e Message (string)

Documentação interativa

https://app.liftflex.com/Liftflex_API/rest/v2/#/

Abra no navegador, expanda cada endpoint e use Try it out para testar com sua API Key.

Abrir Swagger UI ↗

Casos de uso

Portal do condômino

Exiba chamados e boletos do cliente consultando a API a partir do CPF/CNPJ ou ID do contrato.

BI e dashboards externos

Alimente Power BI, Metabase ou planilhas com chamados, financeiro e carteira de contratos.

Automação de cobrança

Integre envio de boleto via 99chat e registre confirmação com UpdateWhatsAppBoletoMessage.

Middleware corporativo

Sincronize clientes e produtos entre Liftflex e outros ERPs ou CRMs da holding.

Perguntas frequentes

Onde obtenho a API Key?

Clientes Liftflex recebem a API Key junto com a implantação ou pelo suporte Brim. É a mesma chave usada no Painel Operacional WhatsApp (+55 31 7232-5669, envie "painel").

A documentação é interativa?

Sim. Acesse a documentação Swagger em app.liftflex.com/Liftflex_API/rest/v2 — teste parâmetros e veja schemas de resposta diretamente no navegador.

Todos os endpoints são GET?

Quase todos. Apenas UpdateWhatsAppBoletoMessage utiliza POST com body JSON (WhatsAppBoletoResponse: Status boolean e Message string).

Preciso de contrato adicional para usar a API?

Fale com o comercial Brim (comercial@brim.com.br) sobre disponibilidade, limites e escopo da integração para sua empresa.

Integre com o ecossistema Liftflex

API REST + WhatsApp 99chat + Looming Gateway — conecte operação, cobrança e comunicação em uma plataforma.

WhatsAppLooming Gateway

Pronto para modernizar sua operação?

Fale com nosso time e veja como o Liftflex pode transformar a gestão da sua empresa de conservação de elevadores.

Agende uma conversaFalar no WhatsApp