Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/clinic/context

Contexto aprovado da clínica (perfil para os agentes)

Perfil da clínica que os agentes usam no preload: só fatos aprovados por uma pessoa da clínica e em vigor, um valor por chave. Propostas, rejeitados, revogados e vigência futura nunca aparecem.

Cache: a resposta traz ETag; mande em If-None-Match e, sem mudança, a resposta é 304 sem corpo. version cresce a cada aprovação, edição ou revogação (o evento clinic.profile.updated traz a mesma context_version). meta.nextChangeAt avisa uma troca de vigência já agendada.

Permissão:clinic: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

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}$

  • If-None-MatchstringOpcional

    ETag recebido antes: sem mudança → 304. · Até 200 caracteres

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/clinic/context", {  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": {    "clinicId": "<clinicId>",    "version": 0,    "facts": {      "servicos": {        "itens": [          {            "nome": "Fisioterapia",            "duracaoMin": 50          },          {            "nome": "Pilates"          }        ]      },      "horarios": {        "semana": [          {            "dia": "seg",            "abre": "08:00",            "fecha": "18:00"          }        ]      },      "precos": {        "itens": [          {            "servico": "Fisioterapia",            "valor": 150          }        ],        "formasPagamento": [          "pix",          "credito"        ]      },      "convenios": {        "aceita": true,        "lista": [          {            "nome": "Unimed"          }        ]      },      "politica_cancelamento": {        "antecedenciaHoras": 24,        "cobraFalta": false,        "texto": "Cancelamentos com 24 h de antecedência."      },      "tom_de_voz": {        "estilo": "acolhedor",        "tratamento": "voce",        "usaEmojis": false      },      "endereco": {        "logradouro": "Rua das Flores",        "numero": "100",        "cidade": "Franca",        "uf": "SP"      }    }  },  "meta": {    "etag": "<etag>",    "keys": [      {        "key": "servicos",        "factId": "<factId>",        "version": 1,        "approvedAt": "2026-09-18T14:00:00.000Z",        "effectiveFrom": "2026-09-18T14:00:00.000Z",        "effectiveUntil": "2026-09-18T14:00:00.000Z"      }    ],    "missingRequired": [      "servicos"    ],    "nextChangeAt": "2026-09-18T14:00:00.000Z"  }}

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.

304

— Sem mudança desde o ETag informado em If-None-Match.

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

Esta operação tem limite próprio: 300 requisições / 60 s por token, clínica e agente. Sobre limites

Testar no Swagger(abre em nova aba)