Listar agendamentos

GET/v1/appointments

Lista os agendamentos da empresa dona do token, do mais recente pro mais antigo.

Exemplos de uso

curl "https://app.primevisita.com.br/v1/appointments?page=1&perPage=30" \
  -H "Authorization: Bearer SEU_TOKEN"

Parâmetros

statusQuery stringstring

Descrição

Filtra pelo status: AGENDADO, REALIZADO, CANCELADO, REAGENDADO, PENDENTE ou NAO_FINALIZADO.

Como encontrar

Um dos 6 valores fixos ao lado.

doctorIdQuery stringstring

Descrição

Filtra pelos agendamentos de um médico específico.

Como encontrar

Vem do campo id de um médico retornado por GET /v1/doctors.

fromQuery stringstring (ISO 8601)

Descrição

Só agendamentos com scheduledAt a partir desta data/hora (inclusive).

Como encontrar

Qualquer data no formato AAAA-MM-DD ou ISO completo (ex.: 2026-08-01 ou 2026-08-01T00:00:00Z).

toQuery stringstring (ISO 8601)

Descrição

Só agendamentos com scheduledAt até esta data/hora (inclusive).

Como encontrar

Mesmo formato de from.

pageQuery stringnumber

Descrição

Página dos resultados, começando em 1. Padrão: 1.

Como encontrar

Use o totalPages da resposta pra saber até onde paginar.

perPageQuery stringnumber

Descrição

Itens por página, de 1 a 100. Padrão: 30.

Como encontrar

Escolha livre — 100 é o teto aceito pela rota.

Exemplos de saída

200 — lista paginada

200

result vem null enquanto o agendamento não é finalizado. mode é VIDEO ou PRESENCIAL.

{
  "data": [
    {
      "id": "6a4d18dcc56c1026a5d0c138",
      "doctorId": "6a4c24b6a893d880917dfc48",
      "doctorName": "SERGIO ZILIO",
      "scheduledAt": "2026-12-12T15:00:00.000Z",
      "mode": "VIDEO",
      "status": "REALIZADO",
      "result": "JA_E_PARCEIRO",
      "observations": null,
      "createdAt": "2026-07-07T15:18:52.993Z",
      "updatedAt": "2026-07-08T16:08:29.560Z"
    }
  ],
  "page": 1,
  "perPage": 30,
  "total": 28,
  "totalPages": 1
}

Exemplos de erro

401 — token inválido

401

{ "error": "Token inválido ou revogado." }

403 — sem escopo

403

{ "error": "Este token não tem o escopo \"appointments:read\"." }

429 — limite excedido

429

{ "error": "Limite de requisições excedido." }