Pular para o conteúdo principal
GET
cURL
Consultar não reserva o horário. Para reservar, envie date e time ao criar o protocolo ou ao agendar.
Veja também: Erros

Autorizações

Authorization
string
header
obrigatório

API key criada no portal do parceiro.

Parâmetros de consulta

from
string<date>

Primeiro dia da consulta. Formato AAAA-MM-DD. Padrão: hoje, em Brasília. Vai de hoje até bookable_until.

days
integer
padrão:7

Quantidade de dias seguidos, a partir de from. Inclui fins de semana.

Intervalo obrigatório: 1 <= x <= 7

Resposta

200 - application/json

Dias consultados, com os horários livres de cada um.

data
object[]
obrigatório

Um item por dia consultado, em ordem de data. Inclui dias sem horário livre. Pode ter menos itens que days perto de bookable_until.

has_more
boolean
obrigatório

true se há dias agendáveis depois do último dia de data. Peça os próximos com from.

Exemplo:

true

bookable_until
string<date>
obrigatório

Último dia agendável. Formato AAAA-MM-DD.

Exemplo:

"2026-11-19"

timezone
string
obrigatório

Fuso horário de date e times, hoje America/Sao_Paulo.

Exemplo:

"America/Sao_Paulo"

object
string
obrigatório

Sempre list.

Allowed value: "list"