Lista de APIs privadas
Rotas privadas de consulta com método, endpoint e exemplo de resposta
Rotas privadas de consulta com método, endpoint e exemplo de resposta
Esta é a lista completa das APIs privadas de consulta publicadas hoje.
As operações privadas de escrita ficaram documentadas separadamente para manter a navegação humana organizada:
Cadastros CRM · criar e atualizarAtividades e follow-ups · criar e agirReuniões · criar e agirConsultório · criar e agirUse o token privado da empresa no cabeçalho:
Onde encontrar:
Token API;Para cada endpoint publicado abaixo, esta página mostra:
Nesta primeira fase das integrações privadas, os endpoints publicados aqui são de leitura (GET).
Authorization: Bearer;100 registros por página;items, count, limit, offset, hasMore e links;links, o href ilustrado abaixo acompanha o próprio endpoint mostrado.Método: GET
Endpoint: /simplificav2/lead
Retorna as levantadas de mão recebidas pela integração de leads.
Conceito importante:
pessoa_id.Campos de leitura mais úteis:
id: identificador do evento recebido;pessoa_id: pessoa vinculada no CRM, quando houver;novo_na_empresa: indica se o evento criou um lead novo (S) ou se foi associado a alguém já existente (N);origem_texto e consultor_texto: texto recebido ou resolvido no processamento;utm_json: objeto JSON completo das UTMs recebidas;custom_json: objeto JSON com os campos customizados enviados na integração.Observação:
utm_* não são duplicados no topo da resposta;utm_json.Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/atividade
Retorna a lista de atividades da empresa cadastradas no Simplifica.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/atividade_follow_up
Retorna a lista de follow-ups de atividades da empresa.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/atividade_motivo
Retorna os motivos de atividade da empresa.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/atividade_motivo_padrao
Retorna os motivos internos usados pelo sistema em fluxos operacionais de atividade.
Leitura prática:
ativo para saber se o motivo ainda está válido para uso interno;Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/categoria
Retorna a lista de categorias da empresa cadastradas no Simplifica.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/consultor
Retorna os consultores cadastrados na empresa.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/endereco
Lista os endereços cadastrados para as pessoas, com dados completos de localização.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/pessoa
Retorna a lista de pessoas da empresa cadastradas no Simplifica.
Como separar leads e clientes:
tipo_pessoa_cliente = "L";tipo_pessoa_cliente = "C".Exemplos úteis:
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/pessoa_motivo_inativacao
Retorna a lista de motivos de inativação de pessoa da empresa.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/pessoa_origem
Lista as origens disponíveis para classificar pessoas no CRM.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/segmento
Retorna a lista de segmentos da empresa cadastrados no Simplifica.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/tag
Retorna as tags publicadas no módulo de leitura.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/reuniao
Retorna a lista de todas as reuniões da empresa cadastradas no Simplifica.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/reuniao_motivo
Retorna a lista de todos os motivos de reunião da empresa.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/reuniao_motivo_cancelamento
Retorna a lista de todos os motivos de cancelamento de reunião da empresa.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/categoria_produto
Retorna a lista de categorias de produto ou serviço da empresa.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/etapa_negociacao
Retorna a lista de todas as etapas de negociação da empresa.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/motivo_cancelamento
Lista os motivos de cancelamento comercial disponíveis para oportunidade, venda ou ambos.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/oportunidade
Lista oportunidades da empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/oportunidade_item
Retorna os itens de produtos, serviços ou kits vinculados às oportunidades.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/origem_comercial
Lista as origens comerciais disponíveis para classificar entradas e resultados do funil.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/produto
Retorna somente produtos da empresa.
Observações:
movimenta_estoque retorna S ou N;un_medida pode trazer códigos como UN (unidade), LT (litro) e PC (peça).Exemplo de chamada:
Método: GET
Endpoint: /simplificav2/servico
Retorna somente serviços da empresa que não estão marcados como procedimento.
Observações:
Exemplo de chamada:
Método: GET
Endpoint: /simplificav2/procedimento
Retorna somente procedimentos da empresa.
Observações:
Exemplo de chamada:
Método: GET
Endpoint: /simplificav2/kit
Retorna somente kits comerciais da empresa.
Observações:
itens, com a composição atual do kit;Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/estoque
Retorna somente produtos da empresa com saldo de estoque diferente de zero.
Observações:
movimenta_estoque = "S";Exemplo de chamada:
Método: GET
Endpoint: /simplificav2/estoque/{id}/movimentacao
Retorna o histórico de movimentações de estoque de um produto específico.
Observações:
id do produto;Exemplo de chamada:
Método: GET
Endpoint: /simplificav2/produto_servico
Retorna o catálogo completo da empresa com produtos, serviços, procedimentos e kits.
Observações:
tipo identifica quando o item é produto, serviço ou kit;procedimento = "S" indica que o item é um procedimento dentro do grupo de serviços;produto, servico, procedimento e kit.Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/venda
Retorna as vendas cadastradas no sistema.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/venda_item
Retorna os itens das vendas cadastradas no sistema.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/motivo_consulta
Retorna os motivos de consulta cadastrados para a empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/consulta_motivo_cancelamento
Retorna os motivos de cancelamento de consulta da empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/bloqueio_agenda
Retorna os bloqueios de agenda do consultório com os profissionais vinculados.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/preco_profissional
Retorna a tabela de preço por profissional da empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/consulta
Retorna as consultas do consultório da empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/consulta_item
Retorna os procedimentos vinculados às consultas da empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/consulta_material
Retorna os materiais consumidos por procedimento nas consultas da empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/categoria_financeira
Retorna as categorias financeiras publicadas no módulo de leitura.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/centro_custo
Retorna os centros de custo publicados no módulo financeiro.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/conta_bancaria
Retorna as contas bancárias publicadas no módulo financeiro.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/despesa
Retorna as despesas cadastradas para a empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/despesa_parcelada
Retorna as despesas parceladas cadastradas para a empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/despesa_recorrente
Retorna as despesas recorrentes cadastradas para a empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/receita
Retorna as receitas cadastradas para a empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/receita_parcelada
Retorna as receitas parceladas cadastradas para a empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/receita_recorrente
Retorna as receitas recorrentes cadastradas para a empresa autenticada.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/tipo_pagamento
Retorna os tipos de pagamento publicados no módulo financeiro.
Exemplo de chamada:
Exemplo de resposta:
Método: GET
Endpoint: /simplificav2/assinatura_oportunidade
Lista oportunidades ganhas com informações relacionadas a assinaturas e recorrência.
Exemplo de chamada:
Exemplo de resposta: