Pular para o conteúdo
Agenda

Buscar reunião por id

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

Parâmetros de caminho

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

  • idstringobrigatório
    • tamanho mín. 1

Respostas

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

200Deu certoapplication/json

A reunião pedida, com contato, responsável, status, desfecho e procedência de criação (createdBySource).

V1Appointment

  • idstring
  • contactIdstring | null
  • contactNamestring | null
  • opportunityIdstring | null
  • titlestring
  • startAtstring | null
  • endAtstring | null
  • locationstring | null
  • conferenceUrlstring | null
  • calendarKeystring | null
  • assigneeUserIdstring | null
  • statusstring
    • um de"scheduled""canceled"
  • outcomestring | null
    • um de"realizada""noshow""reagendada"
  • sourcestring
  • createdAtstring
  • createdByUserIdstring | null
  • createdBySourcestring
    • um de"crm""public_booking""api""automation""import""system""google_calendar"
  • updatedAtstring
  • canceledAtstring | null
  • outcomeAtstring | null
  • recoveredFromAppointmentIdstring | null
  • externalIdstringpode faltar

    Só em source: "google_calendar": o id do evento no Google Agenda (o id do events.list).

  • calendarIdstringpode faltar

    Só em source: "google_calendar": a agenda do Google de onde o evento veio, como a conexão a guarda (primary = a agenda principal da conta conectada). O dono da conta é o assigneeUserId.

  • allDaybooleanpode faltar

    Só em source: "google_calendar": evento de dia inteiro (o startAt é a meia-noite UTC do dia).

  • externalStatusstringpode faltar

    Só em source: "google_calendar": a situação crua no Google — confirmed, tentative ou cancelled. status traduz para o vocabulário da API (cancelled → canceled; as outras → scheduled).

  • visibilitystringpode faltar

    Só em source: "google_calendar": a privacidade que o dono escolheu para a agenda conectada, a mesma da tela da agenda. busy ("só ocupado") = a API mostra exatamente o que a tela mostra: o horário, o dono e o título "Ocupado" — attendees e htmlLink vêm null. details = o título real, os convidados e o link (evento sem título no Google também sai "Ocupado", como na tela).

    • um de"details""busy"

  • Só em source: "google_calendar": os convidados com a resposta de cada um. [] = evento sem convidado. null = agenda em modo "só ocupado" (visibility: "busy"), ou evento espelhado antes desta versão da API que ainda não passou pelo próximo sync (o espelho regrava cada agenda pelo menos uma vez por dia).

    Cada item — V1CalendarAttendee

    • emailstring

      E-mail do convidado (minúsculas).

    • responseStatusstring | null

      A resposta ao convite, no vocabulário do Google: needsAction, accepted, tentative ou declined.

    • organizerboolean

      true = quem organiza o evento.

    • selfboolean

      true = a própria conta Google conectada (o dono da agenda).

  • htmlLinkstring | nullpode faltar

    Só em source: "google_calendar": o link do evento no Google Agenda (abre para quem tem acesso à agenda). null nos mesmos casos de attendees.