Pular para o conteúdo
Agenda

Horários livres de uma agenda

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/calendars/{id}/slots
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcalendars.read

Use date=YYYY-MM-DD para um dia, ou from/to (máx. 7 dias, §9.24). Todas as regras da agenda valem (janelas, folgas, buffers, teto/dia, antecedência mínima, free/busy do calendário conectado).

Parâmetros de caminho

Entram no próprio endereço, no lugar das chaves.

  • idstringobrigatório
    • tamanho mín. 1

Parâmetros de consulta

Vão na querystring, depois do ?.

  • datestringopcional
    • regex "^\\d{4}-\\d{2}-\\d{2}$"
  • fromstringopcional
    • regex "^\\d{4}-\\d{2}-\\d{2}$"
  • tostringopcional
    • regex "^\\d{4}-\\d{2}-\\d{2}$"
  • tzstringopcional
    • padrão "America/Sao_Paulo"
    • tamanho 1–80
  • assigneeUserIdstringopcional

Respostas

7 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Horários livres da agenda no dia (ou na janela de até 7 dias), já com o vendedor que a distribuição resolveu para cada horário. slots: [] é sucesso — quer dizer agenda cheia (ou fora da janela de atendimento), não erro.

V1SlotsResponse

  • timezonestring

  • Cada item — V1Slot

    • startAtstring
    • endAtstring
    • assigneeUserIdstring