Consultar disponibilidade

Escopo: availability:read — Horários livres e ocupados das agendas.

Agendas que atendem o serviço e os horários de cada uma no intervalo, com a situação de cada horário.

campoobrigatório
bizIdsimuid do estabelecimento
serviceIdsimid do serviço (veja Listar serviços)
start, endsimISO 8601. Com offset (-03:00, Z) vale o instante; sem offset (2026-10-16, 2026-10-16T08:00) é horário do negócio. Máx. 31 dias. end é exclusivo.
resourceIdnãosó esta agenda

Resposta

  • end do slot = início + duração do serviço.
  • status: AVAILABLE, OCCUPIED (agendamento existente), BLOCKED (bloqueio/férias da agenda) ou PAST (já passou ou começa em menos de 5 min).
  • reason (só em OCCUPIED): RESOURCE_FULL, SERVICE_REQUIRES_EXCLUSIVITY, SERVICE_ONE_PER_SLOT, OTHER_SERVICE_EXCLUSIVE, OTHER_SERVICE_ONE_PER_SLOT.
  • Agendas desligadas e serviços desligados não aparecem.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

uid do estabelecimento (BIZ_OWNER).

string
required

id de /v1/services.

string
required

ISO 8601. Com offset vale o instante; sem offset é horário do negócio.

string
required

ISO 8601, exclusivo. No máximo 31 dias depois de start.

string | null

Só esta agenda (id de /v1/agendas).

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json