Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/onboarding/facts

Perfil da clínica: fatos por chave (vigente, proposta e versão)

Um grupo por chave (servicos, horarios, precos, convenios, politica_cancelamento, tom_de_voz, endereco), com o fato aprovado em vigor (current), o aprovado com vigência futura (upcoming), a proposta aberta da Renata ou do formulário (proposal) e a version da chave — mande-a em If-Match ao aprovar, rejeitar, informar ou revogar.

Filtros: key (uma chave; desconhecida → 422 unknown_fact_key), status (grupos com algum fato nesse status entre os exibidos) e include=history (todos os fatos da chave). meta.missingRequired lista as obrigatórias que ainda bloqueiam a conclusão. Leitura liberada com o teste grátis vencido.

Permissão:onboarding:read

Autenticaçã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 consulta

  • keystringOpcional

    Só esta chave. · Entre 1 e 64 caracteres

  • statusstringOpcional

    Só grupos com algum fato neste status. · Valores: proposto, aprovado, rejeitado, substituido, revogado

  • includestringOpcional

    history = inclui todos os fatos da chave. · Valores: history

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clí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/onboarding/facts", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": [    {      "key": "servicos",      "label": "<label>",      "required": true,      "version": 0,      "current": {        "id": "<id>",        "key": "servicos",        "status": "proposto",        "value": "<value>",        "origin": "agente",        "sourceMessageId": "<sourceMessageId>",        "evidence": "<evidence>",        "confidence": 1,        "proposedBy": "<proposedBy>",        "proposedAt": "2026-09-18T14:00:00.000Z",        "decidedBy": "<decidedBy>",        "decidedAt": "2026-09-18T14:00:00.000Z",        "note": "<note>",        "edited": true,        "effectiveFrom": "2026-09-18T14:00:00.000Z",        "effectiveUntil": "2026-09-18T14:00:00.000Z",        "version": 1      },      "upcoming": {        "id": "<id>",        "key": "servicos",        "status": "proposto",        "value": "<value>",        "origin": "agente",        "sourceMessageId": "<sourceMessageId>",        "evidence": "<evidence>",        "confidence": 1,        "proposedBy": "<proposedBy>",        "proposedAt": "2026-09-18T14:00:00.000Z",        "decidedBy": "<decidedBy>",        "decidedAt": "2026-09-18T14:00:00.000Z",        "note": "<note>",        "edited": true,        "effectiveFrom": "2026-09-18T14:00:00.000Z",        "effectiveUntil": "2026-09-18T14:00:00.000Z",        "version": 1      },      "proposal": {        "id": "<id>",        "key": "servicos",        "status": "proposto",        "value": "<value>",        "origin": "agente",        "sourceMessageId": "<sourceMessageId>",        "evidence": "<evidence>",        "confidence": 1,        "proposedBy": "<proposedBy>",        "proposedAt": "2026-09-18T14:00:00.000Z",        "decidedBy": "<decidedBy>",        "decidedAt": "2026-09-18T14:00:00.000Z",        "note": "<note>",        "edited": true,        "effectiveFrom": "2026-09-18T14:00:00.000Z",        "effectiveUntil": "2026-09-18T14:00:00.000Z",        "version": 1      },      "history": [        {          "id": "<id>",          "key": "servicos",          "status": "proposto",          "value": "<value>",          "origin": "agente",          "sourceMessageId": "<sourceMessageId>",          "evidence": "<evidence>",          "confidence": 1,          "proposedBy": "<proposedBy>",          "proposedAt": "2026-09-18T14:00:00.000Z",          "decidedBy": "<decidedBy>",          "decidedAt": "2026-09-18T14:00:00.000Z",          "note": "<note>",          "edited": true,          "effectiveFrom": "2026-09-18T14:00:00.000Z",          "effectiveUntil": "2026-09-18T14:00:00.000Z",          "version": 1        }      ]    }  ],  "meta": {    "requiredKeys": [      "servicos"    ],    "missingRequired": [      "servicos"    ],    "contextVersion": 0  }}

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.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger(abre em nova aba)