Referência da API
206 operações em 22 grupos, geradas do contrato OpenAPI 1.0.0.
Sistema
Saúde do serviço (sem autenticação).
Cadastro
Autocadastro da clínica pelo próprio dono: clínica, acesso de administrador e teste grátis do plano numa chamada idempotente.
Sessão
Usuário autenticado, clínicas acessíveis e contexto ativo.
Clínica
Dados da clínica ativa e logo. Admin da plataforma: cadastro de tenants.
- GET
/v1/clinicDados da clínica ativa - PATCH
/v1/clinicAtualizar dados da clínica - PUT
/v1/clinic/logoEnviar logo da clínica (multipart/form-data, campo "file") - DELETE
/v1/clinic/logoRemover logo da clínica - GET
/v1/clinicsListar clínicas (somente equipe da plataforma) - POST
/v1/clinicsCadastrar clínica (tenant) — somente platform_admin
Usuários
Vínculos (memberships), perfis de acesso e convites.
- GET
/v1/users/rolesPerfis de acesso e permissões efetivas - GET
/v1/usersListar usuários da clínica (inclui convites pendentes) - GET
/v1/users/countsContagem de usuários por status (KPIs da tela) - GET
/v1/users/{id}Detalhe de um usuário - PATCH
/v1/users/{id}Alterar perfil de acesso / vínculo com profissional - POST
/v1/users/{id}/suspendSuspender acesso - POST
/v1/users/{id}/reactivateReativar acesso - POST
/v1/users/{id}/revokeRevogar acesso (inclui convite pendente) - POST
/v1/invitationsConvidar usuário (e-mail + perfil) - POST
/v1/invitations/{id}/resendReenviar convite (gera novo link e renova a validade) - DELETE
/v1/invitations/{id}Cancelar convite pendente - POST
/v1/invitations/acceptAceitar convite (usuário convidado, já autenticado na plataforma)
Pacientes
Cadastro, ficha, evoluções (prontuário) e tarefas.
- GET
/v1/patientsListar pacientes - POST
/v1/patientsCadastrar paciente - GET
/v1/patients/countsContagens dos segmentos (chips) da tela Pacientes - GET
/v1/patients/tagsTags distintas dos pacientes da clínica (com contagem) - GET
/v1/patients/summaryKPIs da tela Pacientes (e da Home) - GET
/v1/patients/{id}Ficha do paciente - PATCH
/v1/patients/{id}Atualizar paciente - DELETE
/v1/patients/{id}Excluir paciente (exclusão lógica, recuperável) - GET
/v1/patients/{id}/timelineHistórico do paciente (humanos e agentes no mesmo trilho) - GET
/v1/patients/{id}/evolutionsEvoluções / prontuário do paciente - POST
/v1/patients/{id}/evolutionsRegistrar evolução - GET
/v1/patients/{id}/tasksTarefas do paciente - POST
/v1/patients/{id}/tasksCriar tarefa - PATCH
/v1/patients/{id}/tasks/{taskId}Atualizar / concluir tarefa - DELETE
/v1/patients/{id}/tasks/{taskId}Excluir tarefa
Serviços
Cadastro de serviços — fonte única do painel.
Profissionais
Equipe que atende e disponibilidade.
- GET
/v1/professionalsListar profissionais - POST
/v1/professionalsCadastrar profissional - GET
/v1/professionals/{id}Detalhe do profissional - PATCH
/v1/professionals/{id}Editar profissional - DELETE
/v1/professionals/{id}Excluir profissional (exclusão lógica) - GET
/v1/professionals/{id}/availabilityJanelas de disponibilidade do profissional - PUT
/v1/professionals/{id}/availabilitySubstituir janelas de disponibilidade
Agenda
Agendamentos/sessões: criar, confirmar, reagendar, cancelar com motivo, marcar realizada/falta.
- GET
/v1/appointmentsListar agendamentos (lista / filtros) - POST
/v1/appointmentsCriar agendamento (ou evento interno) - GET
/v1/appointments/calendarAgendamentos de um intervalo (visões semana/dia/mês, sem paginação) - GET
/v1/appointments/summaryKPIs de Atendimentos (semana / dia) - GET
/v1/appointments/attentionSessões que dependem da equipe (contagens leves para a Início) - GET
/v1/appointments/{id}Detalhe do atendimento - PATCH
/v1/appointments/{id}Editar sala, modalidade, tags, observações e registro clínico da sessão - POST
/v1/appointments/{id}/confirmConfirmar presença - POST
/v1/appointments/{id}/startIniciar atendimento (em andamento) - POST
/v1/appointments/{id}/completeMarcar como realizada (compareceu) - POST
/v1/appointments/{id}/no-showRegistrar falta (não compareceu) - POST
/v1/appointments/{id}/cancelCancelar com motivo - POST
/v1/appointments/{id}/rescheduleReagendar (nova data/horário e, opcionalmente, outro profissional) - POST
/v1/appointments/{id}/approveAprovar sugestão de agendamento do agente - POST
/v1/appointments/{id}/rejectRecusar sugestão de agendamento do agente - POST
/v1/appointments/{id}/ratingRegistrar nota da pesquisa de satisfação (pós-atendimento)
Leads
CRM e funil: etapas, mover com motivo, próxima ação, conversão.
- GET
/v1/leadsListar leads (lista e colunas do funil) - POST
/v1/leadsCadastrar lead manualmente - GET
/v1/leads/countsContagens dos segmentos (chips e KPIs da tela Leads) - GET
/v1/leads/boardQuadro do funil: por etapa, o total e os primeiros cartões - GET
/v1/leads/forecastPrevisão de fechamento: leads abertos por mês previsto - GET
/v1/leads/metadataEtapas, origens, canais e motivos de "Fora do perfil" - GET
/v1/leads/summaryKPIs, funil, origens e série semanal - GET
/v1/leads/{id}Detalhe do lead - PATCH
/v1/leads/{id}Atualizar lead (dados, responsável, próxima ação) - DELETE
/v1/leads/{id}Excluir lead (exclusão lógica, recuperável) - GET
/v1/leads/{id}/timelineTimeline do lead (mensagens, agentes, follow-ups, transferências) - POST
/v1/leads/{id}/stageMover etapa do funil - POST
/v1/leads/{id}/convertConverter lead em paciente ("Virou paciente") - GET
/v1/leads/labelsEtiquetas de lead da clínica - POST
/v1/leads/labelsCriar etiqueta de lead - PATCH
/v1/leads/labels/{id}Renomear ou trocar a cor de uma etiqueta - DELETE
/v1/leads/labels/{id}Excluir etiqueta de lead
Comunicação
Caixa de entrada omnichannel: conversas, mensagens, assumir/devolver ao agente.
- GET
/v1/conversationsListar conversas (abas, canal, responsável, busca e ordenação no servidor) - POST
/v1/conversationsIniciar conversa com um contato - GET
/v1/conversations/countsContadores das abas da caixa de entrada (leve; sem itens) - GET
/v1/conversations/{id}Conversa com dados do contato e últimos agendamentos - PATCH
/v1/conversations/{id}Arquivar/desarquivar, marcar como lida, tags - GET
/v1/conversations/{id}/messagesMensagens da conversa (mais recentes primeiro; use o cursor para carregar as anteriores) - POST
/v1/conversations/{id}/messagesEnviar mensagem (humano ou agente) / registrar recebida (token de serviço) - PATCH
/v1/conversations/{id}/messages/{messageId}Atualizar status de entrega (somente token de serviço) - POST
/v1/conversations/{id}/takeoverAssumir conversa (pausar o agente nesta conversa) - POST
/v1/conversations/{id}/releaseDevolver conversa ao agente - POST
/v1/inbound/messagesRegistrar mensagem recebida do paciente (gateway; atômico e idempotente)
Agentes
Time de agentes da clínica: status, pausar/retomar, execuções, tentar de novo.
- GET
/v1/agentsTime de agentes habilitado na clínica - GET
/v1/agents/summaryKPIs do módulo Agentes - POST
/v1/agents/pausePausar todos os agentes da clínica - GET
/v1/agents/{key}Detalhe do agente (painel lateral) - PATCH
/v1/agents/{key}/configAlterar configuração do agente (horário, limite, aprovação, tom) - POST
/v1/agents/{key}/pausePausar agente - POST
/v1/agents/{key}/resumeRetomar agente - GET
/v1/agents/{key}/runsExecuções do agente (cursor; filtros de status e período) - POST
/v1/agents/{key}/runsRegistrar execução (token de serviço) - POST
/v1/agents/{key}/runs/{runId}/retryTentar de novo uma execução com falha - PATCH
/v1/agents/{key}/stateAtualizar estado e métricas do agente (token de serviço) - POST
/v1/agents/{key}/preflightObservar os gates F02 do agente (sem autorizar execução)
Aprovações
Ações propostas por agentes aguardando decisão humana.
Automações
Catálogo de add-ons, contratar, testar 7 dias, desativar (cobrança proporcional).
- GET
/v1/automationsCatálogo de automações com o estado da clínica - GET
/v1/automations/{id}Detalhe da automação (painel lateral) - POST
/v1/automations/{id}/subscriptionContratar ou iniciar teste de 7 dias - PATCH
/v1/automations/{id}/subscriptionAlterar configurações da automação contratada - DELETE
/v1/automations/{id}/subscriptionDesativar automação
Plano e assinatura
Plano, uso, próxima fatura, faturas, mudar plano, cancelar.
- GET
/v1/billingPlano atual, uso, automações e próxima fatura - GET
/v1/billing/plansPlanos disponíveis (comparação + avisos de limite) - POST
/v1/billing/plan-changesSolicitar mudança de plano - DELETE
/v1/billing/plan-changesDesfazer mudança de plano agendada - POST
/v1/billing/cancellationsSolicitar cancelamento da assinatura - DELETE
/v1/billing/cancellationsDesfazer cancelamento da assinatura ("Manter assinatura") - PATCH
/v1/billing/profileDados e preferências de cobrança (frequência, notas por e-mail, lembrete de vencimento, razão social, CNPJ) - GET
/v1/billing/invoicesFaturas da plataforma - GET
/v1/billing/invoices/{id}Detalhe da fatura - POST
/v1/billing/invoices/{id}/resendReenviar nota fiscal por e-mail - POST
/v1/clinics/{id}/subscription/activateAtivar a assinatura de uma clínica — somente admin da plataforma
Financeiro
Transações (fonte explícita — PRD §17.1), a receber, a pagar, resumo.
- GET
/v1/finance/transactionsTransações (receitas e despesas) - POST
/v1/finance/transactionsLançar receita ou despesa - GET
/v1/finance/totalsTotais dos lançamentos filtrados (quantidade e soma por status) - GET
/v1/finance/seriesSéries diárias do período (recebido acumulado e saldo a receber) - GET
/v1/finance/summaryResumo do período (Visão geral e Transações) - GET
/v1/finance/transactions/{id}Detalhe da transação - PATCH
/v1/finance/transactions/{id}Atualizar transação (ex.: marcar como recebida/paga) - POST
/v1/finance/transactions/{id}/reverseEstornar transação - GET
/v1/finance/receivablesPróximos recebimentos (a receber e atrasados) - GET
/v1/finance/payablesContas a pagar (despesas lançadas + recorrentes) - GET
/v1/finance/recurring-expensesDespesas recorrentes - POST
/v1/finance/recurring-expensesCadastrar despesa recorrente - PATCH
/v1/finance/recurring-expenses/{id}Editar despesa recorrente - DELETE
/v1/finance/recurring-expenses/{id}Excluir despesa recorrente
Fiscal
Emissor de NFS-e da clínica via provedor de emissão: configuração com aprovação do contador, regras versionadas por serviço, fila de revisão gerada pela Agenda, lotes com prévia, modos Simulação/Homologação/Produção (Produção travada por portão e confirmação por ação), histórico por tentativa, XML/PDF imutáveis e webhook do provedor.
- GET
/v1/fiscal/settingsCentral fiscal: configuração, prontidão e modos - PUT
/v1/fiscal/settingsSalvar dados do emissor e preferências fiscais - POST
/v1/fiscal/settings/approvalRegistrar a aprovação do contador (empresa) - POST
/v1/fiscal/modeTrocar o modo (Simulação, Homologação, Produção) - POST
/v1/fiscal/gateRegistrar (ou retirar) evidência do portão de produção - GET
/v1/fiscal/service-rulesRegras fiscais por serviço (com versões) - POST
/v1/fiscal/service-rulesCriar rascunho de regra fiscal para um serviço - PATCH
/v1/fiscal/service-rules/{id}Editar rascunho de regra - POST
/v1/fiscal/service-rules/{id}/approveRegistrar aprovação do contador para a regra - POST
/v1/fiscal/service-rules/{id}/discardDescartar rascunho de regra - POST
/v1/fiscal/candidates/syncBuscar atendimentos realizados (e pagamentos) do período - GET
/v1/fiscal/candidatesFila de revisão (candidatos a nota) - GET
/v1/fiscal/summaryContagens da fila e das notas no modo atual - GET
/v1/fiscal/candidates/{id}Detalhe do candidato - PATCH
/v1/fiscal/candidates/{id}Revisar candidato (tomador, valor, confirmação) - POST
/v1/fiscal/candidates/{id}/ignoreMarcar como "não emitir" (com motivo) - POST
/v1/fiscal/candidates/{id}/restoreVoltar para a fila - GET
/v1/fiscal/batchesLotes - POST
/v1/fiscal/batchesMontar lote com prévia (nada é emitido) - GET
/v1/fiscal/batches/{id}Detalhe do lote (prévia e resultado) - POST
/v1/fiscal/batches/{id}/emitEmitir o lote (confirmando a prévia) - POST
/v1/fiscal/batches/{id}/discardDescartar lote em rascunho - GET
/v1/fiscal/documentsNotas (histórico) - GET
/v1/fiscal/documents/{id}Detalhe da nota com histórico de tentativas - POST
/v1/fiscal/documents/{id}/refreshConsultar a nota no provedor - POST
/v1/fiscal/documents/{id}/cancelCancelar nota autorizada (evento fiscal, nunca exclusão) - GET
/v1/fiscal/documents/{id}/files/{kind}Baixar XML ou PDF da nota - POST
/v1/fiscal/webhooks/{provider}Aviso do provedor de emissão (webhook)
Conhecimento
Base de conhecimento por clínica, governança de uso por IA e revisão.
- GET
/v1/knowledge/articlesListar artigos, FAQs, protocolos e materiais (projeção leve) - POST
/v1/knowledge/articlesCriar artigo (rascunho ou enviado para revisão) - GET
/v1/knowledge/countsContagens da base (categorias e situações do tipo pedido) - GET
/v1/knowledge/categoriesCategorias com contagem de itens - GET
/v1/knowledge/summaryKPIs da base (publicados, categorias, agentes usando, avaliação) - GET
/v1/knowledge/articles/{id}Detalhe do artigo - PATCH
/v1/knowledge/articles/{id}Editar artigo - DELETE
/v1/knowledge/articles/{id}Excluir artigo (exclusão lógica) - POST
/v1/knowledge/articles/{id}/submit-reviewEnviar para revisão - POST
/v1/knowledge/articles/{id}/reviewRevisar artigo (aprovar = publicar; reprovar exige motivo)
Integrações
Conectar/desconectar/testar, sincronização e histórico. Segredos nunca são devolvidos.
- GET
/v1/integrationsCatálogo de integrações com o status da clínica - GET
/v1/integrations/{id}Detalhe da integração (conta, sincronização, avisos automáticos) - POST
/v1/integrations/{id}/connectionConectar integração - PATCH
/v1/integrations/{id}/connectionPausar/retomar e ajustar sincronização (modo, calendários, opções) - DELETE
/v1/integrations/{id}/connectionDesconectar integração - POST
/v1/integrations/{id}/connection/confirmConfirmar conexão (callback da plataforma — somente token de serviço) - POST
/v1/integrations/{id}/testTestar conexão - GET
/v1/integrations/{id}/logsHistórico da integração - GET
/v1/outboxEventos do outbox da clínica (entregas ao motor de automação) - POST
/v1/outbox/{id}/retryReenviar evento do outbox agora
Auditoria
Histórico de ações (append-only), filtros e exportação CSV.
Relatórios
Endpoints agregados usados pelas abas de Relatórios e pela Home.
- GET
/v1/reports/homeKPIs da Home (Command Center) - GET
/v1/reports/overviewAba "Visão geral" - GET
/v1/reports/patientsAba "Pacientes" - GET
/v1/reports/leadsAba "Leads" (funil do período) - GET
/v1/reports/scheduleAba "Agenda" (ocupação por dia da semana e status) - GET
/v1/reports/financeAba "Financeiro" (receita × despesas acumuladas, comparação com o período anterior) - GET
/v1/reports/communicationAba "Atendimento" (mensagens por canal, tempo de resposta, resolução por agente) - GET
/v1/reports/teamAba "Equipe" (desempenho por profissional) - GET
/v1/reports/performanceSéries mensais (6 meses) — receita, consultas, pacientes, retorno, leads, conversão, ticket médio - GET
/v1/reports/satisfactionSatisfação dos pacientes (pesquisa pós-atendimento, nota 1–5)
Privacidade
Pedidos LGPD do próprio usuário.