Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/appointments/calendar

Agendamentos de um intervalo (visões semana/dia/mês, sem paginação)

Intervalo máximo de 62 dias; até 2.000 itens. Mesmos filtros da listagem.

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

  • limitintegerOpcional

    Itens por página (1–100). · Padrão: 25 · Entre 1 e 100

  • cursorstringOpcional

    Cursor opaco recebido em meta.nextCursor. · Até 200 caracteres

  • pageintegerOpcional

    Paginação numerada (tabelas): página 1-based, offset = (page − 1) × limit. Ignorado quando há cursor. Listas longas/feeds devem usar cursor. · Entre 1 e 200

  • sortstringOpcional

    Ordenação: campos separados por vírgula, prefixo "-" = decrescente. Permitidos: date, start, startsAt, createdAt, status. Padrão: date,start. · Até 120 caracteres

  • fromstringObrigatório

    Formato AAAA-MM-DD

  • tostringObrigatório

    Formato AAAA-MM-DD

  • professionalstringOpcional

    professional_keys separados por vírgula.

  • servicestringOpcional

    service_keys separados por vírgula.

  • statusstringOpcional

    Status separados por vírgula: agendado, confirmado, pendente, em_andamento, realizado, cancelado, remarcacao, faltou.

  • originstringOpcional

    Origens separadas por vírgula: agente, manual, google, site, instagram.

  • modalitystringOpcional

    Valores: presencial, online

  • roomstringOpcional

    Até 64 caracteres

  • kindstringOpcional

    Valores: consulta, interno

  • patientIdstringOpcional

    Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • agentStatestringOpcional

    Valores: agendado, confirmado, sugestao, aguardando_aprovacao, escalado

  • qstringOpcional

    Nome do paciente. · Até 100 caracteres

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/appointments/calendar?from=2026-01-15&to=2026-01-15&limit=25", {  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": [    {      "id": "<id>",      "date": "2026-09-18",      "start": "14:00",      "end": "14:00",      "durationMin": 1,      "startsAt": "2026-09-18T14:00:00.000Z",      "kind": "consulta",      "patient": "<patient>",      "patientId": "<patientId>",      "leadId": "<leadId>",      "professional": {        "key": "<key>",        "name": "<name>"      },      "service": {        "key": "<key>",        "name": "<name>"      },      "status": "agendado",      "statusLabel": "<statusLabel>",      "outcome": "ATTENDED",      "origin": "agente",      "modality": "presencial",      "room": "<room>",      "agent": {        "agentKey": "<agentKey>",        "name": "<name>",        "image": "<image>",        "state": "agendado",        "at": "2026-09-18T14:00:00.000Z",        "note": "<note>"      },      "notes": "<notes>",      "reason": "<reason>",      "nextSteps": [        {          "label": "<label>",          "done": true        }      ],      "clinicalRedacted": true,      "tags": [        "<tag>"      ]    }  ]}

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)