API — Agendamentos / Agenda (/appointments)

CRUD de compromissos da agenda: reuniões, ligações, tarefas e eventos, com vínculo a contato, negócio e responsável, controle de status e integração com Google Meet.

API — Agendamentos

Compromissos da agenda. Base: /api/v1/appointments.

Endpoints

MétodoPathDescrição
GET/appointmentsListar agendamentos
POST/appointmentsCriar agendamento
GET/appointments/{id}Detalhes
PUT/appointments/{id}Atualizar
DELETE/appointments/{id}Excluir

GET /appointments — filtros

ParâmetroTipoDescrição
searchstringtítulo, descrição ou local
statusstringscheduled, confirmed, cancelled, completed
typestringmeeting, call, task, event, other
user_idintegerresponsável
contact_idintegercontato
deal_idintegernegócio
start_from / start_todatetimefaixa de início
sort_bystringstart_at, end_at, created_at, title, status
sort_dirstringasc | desc (padrão asc)
per_pageintegerpadrão 50, máx 100

POST /appointments — criar

Obrigatórios: title e start_at. Se end_at for omitido, é definido como start_at + 1 hora. Padrões: type=meeting, status=scheduled, user_id= usuário do token.

CampoTipoRegras
titlestringobrigatório
start_atdatetimeobrigatório
end_atdatetime≥ start_at
all_daybooleanevento de dia inteiro
descriptionstringmáx 5000
locationstringlocal
typestringmeeting | call | task | event | other
meeting_typestringin_person | online
statusstringscheduled | confirmed | cancelled | completed
colorstringcor hex (ex: #3B82F6)
user_id / contact_id / deal_idintegervínculos
notesstringmáx 5000
POST /api/v1/appointments
{
  "title": "Reunião de alinhamento",
  "start_at": "2026-04-15T14:00:00",
  "end_at": "2026-04-15T15:00:00",
  "type": "meeting",
  "contact_id": 7
}

PUT /appointments/{id}

Mesmos campos do POST (todos opcionais; title não pode ser vazio se enviado).

Formato (detalhe)

Campos básicos (id, title, type, status, start_at, end_at, all_day, location, meeting_type, color, user, contact, deal) mais, no detalhe: description, notes, google_meet_link e google_event_id (quando integrado ao Google Agenda).

api agendamentos appointments agenda integração

Este artigo foi útil?

Artigos Relacionados