API de Lembretes

Lembretes e resumos agendados (recorrentes ou avulsos)

4 endpoints · base https://api.comando.one/v1 · autenticação por chave cmd_live_…

GET/reminders

Listar lembretes

Lembretes e resumos agendados da empresa.

reminders:list

Parâmetros, corpo, resposta e exemplo

Parâmetros

`page`(query)	integer	Número da página (default: 1)
`per_page`(query)	integer	Itens por página (default: 20, máx: 100)
`active`(query)	"true" \| "false"
`scope`(query)	"personal" \| "company"

Resposta 200 — Listagem paginada

`id`	string (uuid)
`scope`	"personal" \| "company"
`audience`	array de "admin" \| "operador" \| "visualizador"	Papéis que recebem (vazio = todos os membros).
`kind`	"manual" \| "digest"
`template_key`	string \| null	Para digest: revenue.summary, receivables.overdue, payables.due, cards.upcoming, nfse.monthly, cashflow.position, mrr.snapshot.
`params`	object	Parâmetros do digest (ex: { period: 'week' } ou { days_ahead: 7 }).
`title`	string \| null
`body`	string \| null
`entity_type`	string \| null
`entity_id`	string \| null (uuid)
`channels`	object
`recurrence_type`	"once" \| "daily" \| "weekly" \| "monthly"
`run_time`	string	HH:MM[:SS], hora local do fuso.
`weekday`	integer \| null	0=domingo … 6=sábado (semanal).
`day_of_month`	integer \| null	1–31 (mensal; meses curtos usam o último dia).
`timezone`	string
`start_date`	string \| null (date)
`end_date`	string \| null (date)
`next_run_at`	string \| null (date-time)
`last_run_at`	string \| null (date-time)
`active`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X GET "https://api.comando.one/v1/reminders" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

POST/reminders

Criar lembrete

Cria um lembrete. ESCOPO: scope='personal' cria um lembrete só do usuário (aparece em 'Meus lembretes'); scope='company' cria para a empresa (todos os membros veem). No chat, scope='personal' usa o usuário autenticado; via chave cmd_live (sem usuário) informe owner_user_id para pessoal. RELATIVO ('daqui 30 min'): { title, remind_in_minutes } — o servidor calcula o horário. ABSOLUTO: { title, remind_at } (ISO, use 'Z' p/ UTC). Em ambos, kind=manual, recurrence_type=once, start_date e run_time são inferidos.

reminders:create

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`scope`	"personal" \| "company"	personal = só do usuário; company = todos da empresa. Default: personal no chat (com usuário), company via chave de API.
`owner_user_id`	string (uuid)	Dono do lembrete pessoal (membro da empresa). No chat é inferido do usuário; só necessário via chave cmd_live para scope=personal.
`kind`	"manual" \| "digest"	Default: manual (ou digest se houver template_key).
`title`obrigatório	string	Título do lembrete (obrigatório para kind=manual).
`body`	string
`template_key`	string	Obrigatório para kind=digest.
`remind_in_minutes`	integer	Atalho RELATIVO: minutos a partir de agora (servidor calcula). Ex.: 'daqui 30min' → 30. Preferir para lembretes relativos.
`remind_in_hours`	number	Atalho RELATIVO em horas (somado a remind_in_minutes, se vier junto).
`remind_at`	string	Atalho ABSOLUTO: instante ISO (use 'Z' para UTC). Vira recurrence once + start_date + run_time no fuso.
`due_date`	string (date)	Atalho SÓ-DATA (YYYY-MM-DD): lembrete pontual nesse dia.
`params`	object
`audience`	array de "admin" \| "operador" \| "visualizador"
`channels`	object
`recurrence_type`	"once" \| "daily" \| "weekly" \| "monthly"	Default once quando se usa remind_in_minutes/remind_at.
`run_time`	string	HH:MM (hora local) — para recorrências.
`weekday`	integer	0–6 (semanal).
`day_of_month`	integer	1–31 (mensal).
`timezone`	string
`start_date`	string (date)
`end_date`	string (date)

Resposta 201 — Lembrete criado

`id`	string (uuid)
`scope`	"personal" \| "company"
`audience`	array de "admin" \| "operador" \| "visualizador"	Papéis que recebem (vazio = todos os membros).
`kind`	"manual" \| "digest"
`template_key`	string \| null	Para digest: revenue.summary, receivables.overdue, payables.due, cards.upcoming, nfse.monthly, cashflow.position, mrr.snapshot.
`params`	object	Parâmetros do digest (ex: { period: 'week' } ou { days_ahead: 7 }).
`title`	string \| null
`body`	string \| null
`entity_type`	string \| null
`entity_id`	string \| null (uuid)
`channels`	object
`recurrence_type`	"once" \| "daily" \| "weekly" \| "monthly"
`run_time`	string	HH:MM[:SS], hora local do fuso.
`weekday`	integer \| null	0=domingo … 6=sábado (semanal).
`day_of_month`	integer \| null	1–31 (mensal; meses curtos usam o último dia).
`timezone`	string
`start_date`	string \| null (date)
`end_date`	string \| null (date)
`next_run_at`	string \| null (date-time)
`last_run_at`	string \| null (date-time)
`active`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/reminders" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"title":"<string>"}'

DELETE/reminders/{id}

Excluir lembrete

reminders:delete

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 204 — Excluído

Sem corpo.

Exemplo

curl -X DELETE "https://api.comando.one/v1/reminders/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

PATCH/reminders/{id}

Atualizar / pausar lembrete

reminders:update

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`kind`	"manual" \| "digest"
`template_key`	string
`title`	string
`body`	string
`params`	object
`audience`	array de string
`channels`	object
`recurrence_type`	"once" \| "daily" \| "weekly" \| "monthly"
`run_time`	string
`weekday`	integer
`day_of_month`	integer
`timezone`	string
`start_date`	string (date)
`end_date`	string (date)
`active`	boolean

Resposta 200 — Atualizado

`id`	string (uuid)
`scope`	"personal" \| "company"
`audience`	array de "admin" \| "operador" \| "visualizador"	Papéis que recebem (vazio = todos os membros).
`kind`	"manual" \| "digest"
`template_key`	string \| null	Para digest: revenue.summary, receivables.overdue, payables.due, cards.upcoming, nfse.monthly, cashflow.position, mrr.snapshot.
`params`	object	Parâmetros do digest (ex: { period: 'week' } ou { days_ahead: 7 }).
`title`	string \| null
`body`	string \| null
`entity_type`	string \| null
`entity_id`	string \| null (uuid)
`channels`	object
`recurrence_type`	"once" \| "daily" \| "weekly" \| "monthly"
`run_time`	string	HH:MM[:SS], hora local do fuso.
`weekday`	integer \| null	0=domingo … 6=sábado (semanal).
`day_of_month`	integer \| null	1–31 (mensal; meses curtos usam o último dia).
`timezone`	string
`start_date`	string \| null (date)
`end_date`	string \| null (date)
`next_run_at`	string \| null (date-time)
`last_run_at`	string \| null (date-time)
`active`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X PATCH "https://api.comando.one/v1/reminders/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

Início rápido, autenticação, SDK, servidor MCP e o playground para testar sem escrever código estão na documentação completa. A especificação em OpenAPI está em api.comando.one/openapi.json.

Outros recursos da API

Clientes (16)Contratos (13)Faturas (12)Webhooks (12)Serviços (9)Split de Pagamentos (9)Catálogos (7)Propostas (6)

Ou deixe a IA usar a API por você

O servidor MCP expõe estes mesmos recursos ao ChatGPT, Claude ou Gemini — com OAuth, sem chave de API.

Conectar um assistente