GET
/agendas/{id}Ver uma agenda
agenda:lermódulo Agenda
GET /agendas/{id}
curl "https://chat.forsi.com.br/api/v1/agendas/f7233bb7-10b6-49d2-aa3b-8c2e7d88064d" \
-H "Authorization: Bearer $FORSI_CHAVE"const resposta = await fetch('https://chat.forsi.com.br/api/v1/agendas/f7233bb7-10b6-49d2-aa3b-8c2e7d88064d', {
headers: {
Authorization: `Bearer ${process.env.FORSI_CHAVE}`,
},
});
const json = await resposta.json();
if (!resposta.ok) throw new Error(`${resposta.status} ${json.erro.codigo}: ${json.erro.mensagem}`);
console.log(json.dados);import os
import requests
resposta = requests.get(
"https://chat.forsi.com.br/api/v1/agendas/f7233bb7-10b6-49d2-aa3b-8c2e7d88064d",
headers={
"Authorization": f"Bearer {os.environ['FORSI_CHAVE']}",
},
timeout=30,
)
corpo = resposta.json()
if not resposta.ok:
raise RuntimeError(f"{resposta.status_code} {corpo['erro']['codigo']}: {corpo['erro']['mensagem']}")
print(corpo["dados"])Resposta 200
{
"dados": {
"id": "f7233bb7-10b6-49d2-aa3b-8c2e7d88064d",
"nome": "Dra. Ana Lima",
"cor": "blue",
"fuso": "America/Sao_Paulo",
"ativa": true,
"duracao_min": 30,
"intervalo_min": 10,
"antecedencia_min": 120,
"horario": {"1":[["09:00","12:00"],["14:00","18:00"]]},
"lembretes": [{"antes_min":1440}],
"mensagem_lembrete": "Oi {nome}, lembrando da sua consulta {data} às {hora}.",
"profissional": {
"id": "27a50fb4-0f76-4c9a-92d0-c2d984d356b9",
"nome": "Maria Souza"
},
"criado_em": "2026-10-04T13:05:12.481Z",
"atualizado_em": "2026-10-04T13:05:12.481Z"
}
}Parâmetros no caminho#
iduuidobrigatórioNo caminho da URL.
Resposta#
200 com {"dados": ...}: Agenda.
iduuidopcional—nomestringopcional—corstringopcional—fusostringopcional- ex.: America/Sao_Paulo
ativabooleanopcional—duracao_minintegeropcional—intervalo_minintegeropcional—antecedencia_minintegeropcional—horarioobjeto livreopcionalDia da semana (0 domingo a 6 sábado) para faixas [início, fim].
lembreteslista de objectopcional—lembretes[].antes_minintegeropcional—mensagem_lembretestringopcional—profissionalobjectopcionalQuando a agenda é de uma pessoa da equipe.
profissional.iduuidopcional—profissional.nomestringopcional—criado_emdata e hora ISO 8601opcional—atualizado_emdata e hora ISO 8601opcional—
Erros#
Todo erro vem como {"erro": {"codigo", "mensagem"}}. Trate pelo codigo: ele não muda.
| Status | Quando |
|---|---|
| 401 | Chave ausente ou inválida (resposta igual para qualquer motivo). |
| 403 | Plano sem API, escopo insuficiente ou https/origem recusados. |
| 404 | Não existe nesta organização. |
| 422 | Dados inválidos ou regra de negócio (ex.: janela_fechada; conta_restrita = a Meta restringiu a conta por spam: erro traz os campos de RestricaoMeta, como ate, escopo, motivo e retry_after_s). |
| 429 | Limite de requisições. Veja Retry-After. |
Códigos de erro que esta área pode devolver28
horario_invalidoData e hora inválidas. Use o formato 2026-10-12T14:00:00-03:00 (sempre com o fuso), com o fim depois do início.janela_grandeA janela de consulta passa do máximo (62 dias).duracao_invalidaDuração inválida: de 5 a 720 minutos (compromisso de até 12 horas).campo_longoUm dos textos passa do tamanho máximo. O campo vem em "detalhe".campo_invalidoCampo obrigatório ou inválido. O campo vem em "detalhe".link_invalidoO link precisa começar com https://.contato_ambiguoInforme só um entre contato_id, conversa_id e telefone.conversa_de_outro_contatoA conversa informada é de outro contato.evento_canceladoO compromisso está cancelado e não pode ser alterado. Marque um novo.evento_finalizadoO compromisso já foi encerrado (concluído ou faltou) e não pode ser alterado.horario_ocupadoEsse horário já está ocupado nessa agenda.horario_bloqueadoEsse horário está bloqueado (folga, almoço ou feriado).fora_do_horarioEsse horário está fora do horário de trabalho da agenda.antecedenciaEsse horário está mais perto do que a antecedência mínima da agenda.compromisso_estado_invalidoestado só pode ser concluido ou faltou. Para confirmar ou cancelar, use as rotas próprias.nada_para_atualizarMande ao menos um campo para atualizar.fuso_invalidoFuso inválido. Use um nome IANA, como America/Sao_Paulo.cor_invalidaCor inválida. Use slate, blue, violet, amber, emerald, green, rose, cyan ou orange.lembretes_invalidosLembretes inválidos: até 5 itens, cada um só com antes_min (1 a 43200).usuario_inexistenteusuario_id não é de uma pessoa desta equipe.agenda_inexistenteAgenda não encontrada (ou inativa, para marcar compromisso).evento_inexistenteCompromisso não encontrado.bloqueio_inexistenteBloqueio não encontrado.agenda_repetidaEssa pessoa já tem uma agenda.limite_agendasLimite de 100 agendas por organização.limite_bloqueiosLimite de 500 bloqueios por organização.bloqueio_tipo_invalidotipo deve ser folga, almoco, feriado ou outro.repeticao_invalidarepetir deve ser nunca, diario, semanal ou anual; repetir_ate só vale com repetição.
Os erros que valem para qualquer rota (chave, limite, JSON) estão em Erros.