Pular para o conteúdo
GET

/v1/clinics

Listar clínicas (somente equipe da plataforma)

Visão cross-tenant do PRD §2.1 / §30.1. Usuários de clínica recebem 403.

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>

Parâmetros

Parâmetros de consulta

  • statusstringOpcional

    Valores: DRAFT, ONBOARDING, READY_FOR_TEST, ACTIVE, SUSPENDED, ARCHIVED

  • qstringOpcional

    Até 100 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/clinics", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",  },})​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": [    {      "id": "<id>",      "name": "<name>",      "status": "<status>",      "city": "<city>"    }  ]}

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