ZeroSync API · v1

Documentação da API

A API REST pública do ZeroSync deixa assistentes, automações e seu próprio código lerem e gravarem seus dados — agenda, finanças, hábitos, listas, objetivos e notas. Tudo isolado por usuário e autenticado por token.

Base URLhttps://app.zerosync.com.br/api/v1

Autenticação

Toda requisição precisa de um Personal Access Token (PAT). Gere o seu na página /api-keys do ZeroSync (no menu do seu perfil). A chave aparece uma única vez — copie e guarde com segurança.

Envie a chave no header Authorization em todas as chamadas:

Authorization: Bearer zsk_live_xxxxx

Escopos

Cada chave carrega um ou mais escopos. Operações de leitura exigem read; operações de escrita exigem write. Sem o escopo certo a API responde 403 insufficient_scope.

Erros

  • 400 — corpo/parâmetros inválidos (campo issues traz os detalhes).
  • 401 — missing_token / invalid_token.
  • 403 — insufficient_scope.
  • 404 — recurso não encontrado.
  • 500 — erro interno.

Exemplos rápidos

Criar uma tarefa

curl -X POST https://app.zerosync.com.br/api/v1/tasks \
  -H "Authorization: Bearer zsk_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Pagar fornecedor",
    "date": "2026-06-03",
    "start_time": "14:00",
    "duration_minutes": 45,
    "category": "Trabalho"
  }'

Lançar uma despesa

curl -X POST https://app.zerosync.com.br/api/v1/transactions \
  -H "Authorization: Bearer zsk_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "expense",
    "amount": 42.9,
    "description": "Almoço",
    "category": "Alimentação",
    "account": "Nubank"
  }'

Consultar o resumo financeiro

curl https://app.zerosync.com.br/api/v1/finance/summary?month=2026-06 \
  -H "Authorization: Bearer zsk_live_xxxxx"

Endpoints

Referência rápida. Veja a especificação interativa completa (parâmetros, schemas e respostas) logo abaixo.

GET/tasksListar tarefas do diaread
POST/tasksCriar tarefawrite
PATCH/tasks/{id}Atualizar tarefawrite
DELETE/tasks/{id}Excluir tarefawrite
GET/transactionsListar transaçõesread
POST/transactionsLançar receita/despesawrite
GET/finance/summaryResumo do mêsread
GET/finance/accountsListar contasread
GET/habitsListar hábitosread
POST/habitsCriar hábitowrite
POST/habits/logRegistrar hábitowrite
GET/shoppingListar comprasread
POST/shoppingAdicionar comprawrite
GET/mediaListar mídiaread
POST/mediaAdicionar mídiawrite
GET/goalsListar objetivosread
POST/goalsCriar objetivowrite
GET/notesListar notasread
POST/notesCriar notawrite

Conectar via MCP

O ZeroSync oferece um servidor MCP (Model Context Protocol) que expõe a API como ferramentas para o Claude Desktop e outros clientes MCP. Assim você conversa em linguagem natural ("lança R$ 50 de mercado", "o que tenho amanhã?") e o assistente chama a API por você.

Adicione o bloco abaixo ao seu claude_desktop_config.json (Configurações → Developer → Edit Config) e troque a chave pela sua:

{
  "mcpServers": {
    "zerosync": {
      "command": "npx",
      "args": ["-y", "zerosync-mcp"],
      "env": {
        "ZEROSYNC_API_KEY": "zsk_live_xxxxx"
      }
    }
  }
}

O pacote zerosync-mcp é publicado no npm e roda via npx — não precisa instalar nada manualmente. Reinicie o Claude Desktop depois de salvar.

Referência interativa

Especificação OpenAPI 3.1 completa, gerada a partir de /api/v1/openapi.json.