Pular para o conteúdo
GET

/v1/owner-interview/catalog

Catálogo versionado da entrevista da dona (owner-interview-v2)

Dado global e versionado: mesma fonte para o Admin e para a Lívia. Fases: 1 (essencial e bloco de agenda M/L), 2 (vender melhor e complementares), 3 (aprofundamento). Ids estáveis: retired lista as perguntas aposentadas na v2 (P05, P12, P13, P14, P28) com quem as substitui; o bloco de agenda é P45–P93 (49 perguntas, 9 blocos). Cada pergunta traz formato, destino (fato do perfil ou artigo), reviewRequired (⚠️), clinicalAssessment (segurança clínica) e showRegistry. Pessoa da clínica (onboarding:read) ou a Lívia (X-Agent-Key: knowledge).

Qualquer uma:onboarding:readowner-interview:agent

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

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/owner-interview/catalog", {  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": {    "version": "<version>",    "total": 1,    "phases": [      {        "phase": 1,        "count": 1      }    ],    "questions": [      {        "id": "P01",        "phase": 1,        "section": "<section>",        "text": "<text>",        "format": "tabela",        "formatDetail": "<formatDetail>",        "agents": [          "<agent>"        ],        "target": {          "type": "fact",          "key": "<key>",          "alsoKeys": [],          "fields": []        },        "reviewRequired": true,        "clinicalAssessment": true,        "showRegistry": true,        "registrySources": [          "<registrySource>"        ],        "note": "<note>",        "priority": "M",        "retired": {          "replacedBy": [],          "reason": "<reason>"        }      }    ],    "retired": [      {        "id": "P01",        "phase": 1,        "section": "<section>",        "text": "<text>",        "format": "tabela",        "formatDetail": "<formatDetail>",        "agents": [          "<agent>"        ],        "target": {          "type": "fact",          "key": "<key>",          "alsoKeys": [],          "fields": []        },        "reviewRequired": true,        "clinicalAssessment": true,        "showRegistry": true,        "registrySources": [          "<registrySource>"        ],        "note": "<note>",        "priority": "M",        "retired": {          "replacedBy": [],          "reason": "<reason>"        }      }    ]  }}

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