# GET /compromissos — Listar compromissos - URL: `GET https://chat.forsi.com.br/api/v1/compromissos` - Acesso: escopo `agenda:ler` · módulos do plano: API + Agenda - Sucesso: `200`, `{"dados": ...}` com lista de `Compromisso` (paginada por cursor) - Página: https://docs.forsi.com.br/api/agenda/listar-compromissos (Markdown: https://docs.forsi.com.br/api/agenda/listar-compromissos.md) Em ordem de horário, paginado por cursor. Filtre por agenda, contato, estado e período. **Parâmetros de consulta (query string)** | Campo | Tipo | Obrigatório | Notas | | --- | --- | --- | --- | | `limite` | integer | não | Itens por página (1 a 100, padrão 50). | | `cursor` | string | não | O valor de `proximo` da página anterior. até 80 caracteres | | `agenda_id` | uuid | não | | | `contato_id` | uuid | não | | | `estado` | "marcado" \| "confirmado" \| "concluido" \| "faltou" \| "cancelado" | não | | | `de` | data e hora ISO 8601 | não | Só compromissos que terminam depois disto. | | `ate` | data e hora ISO 8601 | não | Só compromissos que começam antes disto. | **Exemplo (curl)** ```bash curl "https://chat.forsi.com.br/api/v1/compromissos?de=2026-10-12T00:00:00-03:00&ate=2026-10-19T00:00:00-03:00&estado=marcado" \ -H "Authorization: Bearer $FORSI_CHAVE" ``` **JavaScript (fetch)** ```js const resposta = await fetch('https://chat.forsi.com.br/api/v1/compromissos?de=2026-10-12T00:00:00-03:00&ate=2026-10-19T00:00:00-03:00&estado=marcado', { 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); ``` **Python (requests)** ```python import os import requests resposta = requests.get( "https://chat.forsi.com.br/api/v1/compromissos", headers={ "Authorization": f"Bearer {os.environ['FORSI_CHAVE']}", }, params={ "de": "2026-10-12T00:00:00-03:00", "ate": "2026-10-19T00:00:00-03:00", "estado": "marcado", }, 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` (exemplo)** ```json { "dados": [ { "id": "e0c6d7e8-baef-444c-acaf-8ea96e737165", "agenda_id": "f7233bb7-10b6-49d2-aa3b-8c2e7d88064d", "agenda": "Dra. Ana Lima", "cor": "blue", "titulo": "Consulta de retorno", "inicio": "2026-10-12T17:00:00.000Z", "fim": "2026-10-12T17:30:00.000Z", "fuso": "America/Sao_Paulo", "inicio_local": "2026-10-12T14:00:00-03:00", "fim_local": "2026-10-12T14:30:00-03:00", "duracao_min": 30, "estado": "marcado", "local": "Rua das Flores, 120 - sala 4", "link": "https://meet.google.com/abc-defg-hij", "notas": "Trazer os exames.", "contato_id": "08054a7f-a752-481e-9915-cf4cf944df39", "conversa_id": "495a7cae-128c-4b66-adbc-807b3959c129", "contato": { "id": "08054a7f-a752-481e-9915-cf4cf944df39", "nome": "Maria Souza", "telefone": "+5531988887777", "avatar_url": "https://chat.forsi.com.br/avatar.png" }, "lembretes": [ { "antes_min": 1440, "estado": "texto", "enviar_em": "2026-10-04T13:05:12.481Z", "enviado_em": "2026-10-04T13:05:12.481Z" } ], "criado_por_tipo": "texto", "criado_em": "2026-10-04T13:05:12.481Z", "confirmado_em": "2026-10-04T13:05:12.481Z", "cancelado_em": "2026-10-04T13:05:12.481Z" } ], "proximo": "1791205512481_3791c08d-72dd-4002-89ff-1e14a11c07e5" } ``` **Campos de `Compromisso`** | Campo | Tipo | Obrigatório | Notas | | --- | --- | --- | --- | | `id` | uuid | não | | | `agenda_id` | uuid | não | | | `agenda` | string | não | | | `cor` | string | não | | | `titulo` | string | não | | | `inicio` | data e hora ISO 8601 | não | | | `fim` | data e hora ISO 8601 | não | | | `fuso` | string | não | | | `inicio_local` | string | não | Começo no fuso da agenda, com deslocamento. ex.: 2026-10-12T14:00:00-03:00 | | `fim_local` | string | não | Fim no fuso da agenda, com deslocamento. ex.: 2026-10-12T14:00:00-03:00 | | `duracao_min` | integer | não | | | `estado` | "marcado" \| "confirmado" \| "concluido" \| "faltou" \| "cancelado" | não | | | `local` | string | não | | | `link` | string | não | | | `notas` | string | não | | | `contato_id` | uuid | não | | | `conversa_id` | uuid | não | | | `contato` | object | não | | | `contato.id` | uuid | não | | | `contato.nome` | string | não | | | `contato.telefone` | string | não | | | `contato.avatar_url` | string | não | | | `lembretes` | lista de object | não | | | `lembretes[].antes_min` | integer | não | | | `lembretes[].estado` | string | não | | | `lembretes[].enviar_em` | data e hora ISO 8601 | não | | | `lembretes[].enviado_em` | data e hora ISO 8601 | não | | | `criado_por_tipo` | string | não | | | `criado_em` | data e hora ISO 8601 | não | | | `confirmado_em` | data e hora ISO 8601 | não | | | `cancelado_em` | data e hora ISO 8601 | não | | **Erros** - `401`: Chave ausente ou inválida (resposta igual para qualquer motivo). - `403`: Plano sem API, escopo insuficiente ou https/origem recusados. - `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 comuns aqui: `horario_invalido`, `janela_grande`, `duracao_invalida`, `campo_longo`, `campo_invalido`, `link_invalido`, `contato_ambiguo`, `conversa_de_outro_contato`, `evento_cancelado`, `evento_finalizado`, `horario_ocupado`, `horario_bloqueado`, `fora_do_horario`, `antecedencia`, `compromisso_estado_invalido`, `nada_para_atualizar`, `fuso_invalido`, `cor_invalida`, `lembretes_invalidos`, `usuario_inexistente`, `agenda_inexistente`, `evento_inexistente`, `bloqueio_inexistente`, `agenda_repetida`, `limite_agendas`, `limite_bloqueios`, `bloqueio_tipo_invalido`, `repeticao_invalida`. --- Página: https://docs.forsi.com.br/api/agenda/listar-compromissos · Índice: https://docs.forsi.com.br/llms.txt · Tudo num arquivo: https://docs.forsi.com.br/llms-full.txt