/v1/owner-commands/reads/{operation}
Leitura mascarada para o dono (entradas, agenda do dia, leads, achar paciente)
Somente token de serviço com owner_desk:read. Sem confirmação, mas só responde a sourceMessageId recebida nesta clínica do dono/admin verificado (403 source_not_owner) e com no máximo 2 h (409 source_message_too_old).
- finance_income_summary (from/to; padrão: segunda desta semana até hoje): só agregados — recebido, a receber, quantidade, despesas pagas. Nunca nome de quem pagou.
- agenda_day (date; padrão: amanhã; professionalKey opcional): hora, primeiro nome, serviço e profissional. Sem telefone, observação ou dado clínico. Bloqueios aparecem como "Bloqueio".
- leads_count (from/to; padrão: hoje): quantidade de leads novos no período e por etapa.
- patient_match (name): até 5 pacientes com id, primeiro nome e inicial do sobrenome (para criar sessão). Sem telefone, e-mail ou documento.
owner_desk:readAutenticação
Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar
Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>Parâmetros
Parâmetros de caminho
operationstringObrigatórioValores:
finance_income_summary,agenda_day,leads_count,patient_match
Parâmetros de consulta
sourceMessageIdstringObrigatórioMensagem recebida do dono com a pergunta (a API confere que é do dono verificado e recente). · Entre 1 e 64 caracteres · Padrão (regex):
^[A-Za-z0-9._-]+$fromstringOpcionalFormato
AAAA-MM-DDtostringOpcionalFormato
AAAA-MM-DDdatestringOpcionalFormato
AAAA-MM-DDprofessionalKeystringOpcionalPadrão (regex):
^[a-z0-9-]{2,64}$namestringOpcionalEntre 2 e 80 caracteres
Cabeçalhos
X-Clinic-IdstringOpcionalClínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex):
^[A-Za-z0-9._-]{1,64}$
Exemplo de requisição
Gerado do contrato. Troque os marcadores entre < > pelos seus valores.
const res = await fetch("https://myclinc.leadpoint.com.br/v1/owner-commands/reads/<operation>?sourceMessageId=<sourceMessageId>", { method: "GET", headers: { Authorization: "Bearer <TOKEN>", "X-Clinic-Id": "<clinic_id>", "X-Agent-Key": "<agent_key>", },})if (!res.ok) { const { error } = await res.json() throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()Resposta
{ "data": { "operation": "<operation>", "period": { "from": "<from>", "to": "<to>" }, "result": {}, "text": "<text>" }}Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.
Códigos de erro
Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.
Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).
Unauthorized — Token ausente, inválido ou expirado.
Forbidden — Autenticado, mas sem permissão (perfil ou clínica).
Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).
Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).
Too Many Requests — Limite de requisições excedido (veja Retry-After).
Internal Server Error — Erro interno (sem detalhes expostos).
Service Unavailable — Banco de dados indisponível ou não configurado.
Limites
Esta operação tem limite próprio: 60 requisições / 60 s. Sobre limites