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étodo | Path | Descrição |
|---|---|---|
| GET | /appointments | Listar agendamentos |
| POST | /appointments | Criar agendamento |
| GET | /appointments/{id} | Detalhes |
| PUT | /appointments/{id} | Atualizar |
| DELETE | /appointments/{id} | Excluir |
GET /appointments — filtros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| search | string | título, descrição ou local |
| status | string | scheduled, confirmed, cancelled, completed |
| type | string | meeting, call, task, event, other |
| user_id | integer | responsável |
| contact_id | integer | contato |
| deal_id | integer | negócio |
| start_from / start_to | datetime | faixa de início |
| sort_by | string | start_at, end_at, created_at, title, status |
| sort_dir | string | asc | desc (padrão asc) |
| per_page | integer | padrã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.
| Campo | Tipo | Regras |
|---|---|---|
| title | string | obrigatório |
| start_at | datetime | obrigatório |
| end_at | datetime | ≥ start_at |
| all_day | boolean | evento de dia inteiro |
| description | string | máx 5000 |
| location | string | local |
| type | string | meeting | call | task | event | other |
| meeting_type | string | in_person | online |
| status | string | scheduled | confirmed | cancelled | completed |
| color | string | cor hex (ex: #3B82F6) |
| user_id / contact_id / deal_id | integer | vínculos |
| notes | string | má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