/v1/owner-interview/items
Progresso da entrevista da clínica (uma linha por pergunta)
Sempre as perguntas ATIVAS do catálogo (as aposentadas não entram); as que ainda não têm documento vêm pendente com version: 0. Nunca traz o rascunho (só hasDraft): o valor é lido em GET /owner-interview/items/{questionId}. Filtros opcionais phase e status.
onboarding:readowner-interview:agentAutenticaçã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
phaseintegerOpcionalEntre 1 e 3
statusstringOpcionalpendente → perguntada → aguardando_confirmacao → proposta → aprovada (+ pulada, expirada, rejeitada). · Valores:
pendente,perguntada,aguardando_confirmacao,proposta,aprovada,pulada,expirada,rejeitada
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-interview/items", { 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
{ "data": [ { "questionId": "P01", "catalogVersion": "<catalogVersion>", "retired": true, "phase": 1, "status": "pendente", "version": 0, "target": { "type": "fact", "key": "<key>", "alsoKeys": [ "<alsoKey>" ], "fields": [ "<field>" ] }, "targetRef": "<targetRef>", "reviewRequired": true, "clinicalAssessment": true, "sourceMessageId": "<sourceMessageId>", "askedAt": "2026-09-18T14:00:00.000Z", "answeredAt": "2026-09-18T14:00:00.000Z", "hasDraft": true, "draftValue": "<draftValue>", "updatedAt": "2026-09-18T14:00:00.000Z" } ], "meta": { "catalogVersion": "<catalogVersion>", "total": 1, "byStatus": {} }}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).
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
Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites