API Changelog

2026-10-27

• Users — documented error responses for POST /users, POST /users/{id}, GET /users/{id}, and DELETE /users/{id} (including 403 for permission denied on create, 400 with code: duplicate_email, and 402 when user licenses are exhausted).
• The API documentation now lists super user permissions with an expandable description for each allowed value (not only enum slugs).
• POST /users documents create defaults separately from edit: omitted fields do not inherit account settings from the app (for example capacity_per_day, work_days, and last_calendar_id stay null unless sent). Default role on create is regular.
• POST /users/{id} documents partial update only — omitted fields are unchanged and do not receive create defaults.
• Added a shared error response schema (message, optional code, status) in the documentation.

2026-10-09

• Personal tokens are now the supported way to call the API. Create them in the app under Settings > My tokens and send the value in the x-api-token header.
• Deprecated email-and-password login via POST /auth and DELETE /auth/revoke. Those routes are no longer published.
• Documented teams, team members, custom fields, webhooks, and timesheet approvals.
• Time entries now document to-do link, breaks, external reference, cost, tax, and custom fields. Bulk edit stays out of the public docs.
• To-dos document due date, subtasks, restore, and soft delete. To-do lists document color and restore.
• Detailed report filters that were already supported are published again, including custom fields and invoiced status.
• Single-resource responses are documented inside { "data": ... }.
• Added the Ultimate plan quota of 2,500 requests per day.
• Documented to-do tags, rates, comments, calendars and holidays, days off and vacation, calendar history, profile photos, the user's projects, and user assignments.
• GET /time-entries/current returns the authenticated user's active timer, or data: null when none is running.

2025-11-14

• 🎉 Public release of the RabbitWork API — now available for all customers and third-party integrations.
  The API is officially open for production use, with public documentation, authentication, and rate-limit tiers by plan.
• Defined daily usage quotas per plan:
  • Free / Free Trial / Legacy: 50 requests per day
  • Plus: 1 000 requests per day
  • Business: 5 000 requests per day (soft limit)
  • Business Max: 25 000 requests per day (soft limit)
• Updated GET /projects documentation to include pagination support.
• Added new filters to GET /projects: id, active, customer_id.
• Added new filters to GET /customers: id, active.
• Added new filters to GET /users: id, active.
• Added new filters to GET /tasks: id, active.

2025-11-12

• Introduced Rate Limit policy with per-minute, per-account, per-IP, and authentication-specific limits.
• Added standard response headers for rate-limit tracking: X-RateLimit-Minute, X-RateLimit-AccountDaily, and Retry-After.
• Improved error handling for exceeded limits with specific error codes and warning headers.

2025-07-11

• Deprecated the GET /time-entries endpoint for time entry listings.
• Replaced by /reports/detailed endpoint, which provides enhanced filtering and reporting capabilities.

2024-06-28

• Added new endpoints to support the activity management module:
• /todos — manage tasks and assignments
• /todo-lists — organize tasks into structured lists

2024-01-09

• Added automatic calculation of time_total when creating a Time Entry, if not explicitly provided, using time_start and time_end values when available.
• Improved handling of time_start, time_end, and time_total fields in Time Entries to ensure consistent and predictable results. When only some time fields are provided, the API now automatically fills in the others — prioritizing total time first, then start time, and finally end time. This change prevents mismatched durations and ensures accurate total hours are always recorded, even when partial data is sent in requests.

2023-02-11

• Initial release of the RabbitWork API documentation, launched in closed beta for selected customers.
• Introduced core endpoints for time tracking, users, projects, and customers.
• Established API authentication model using tokens tied to specific User-Agents.

Novidades da API

2026-10-27

• Usuários — documentamos respostas de erro em POST /users, POST /users/{id}, GET /users/{id} e DELETE /users/{id} (incluindo 403 sem permissão para criar, 400 com code: duplicate_email e 402 quando acabam as licenças de usuário).
• A documentação da API passou a listar as permissions de superusuário com descrição expandível de cada valor permitido (não só os slugs do enum).
• POST /users documenta padrões na criação, separados da edição: campos omitidos não herdam configurações da conta no app (por exemplo capacity_per_day, work_days e last_calendar_id ficam null se não forem enviados). Papel padrão na criação: regular.
• POST /users/{id} documenta atualização parcial — campos omitidos não mudam e não recebem padrões de criação.
• Schema comum de erro na documentação (message, code opcional, status).

2026-10-09

• Tokens pessoais passaram a ser a forma suportada de chamar a API. Crie o token no app em Configurações > Meus tokens e envie o valor no header x-api-token.
• Descontinuado o login com e-mail e senha em POST /auth e DELETE /auth/revoke. Essas rotas não são mais publicadas.
• Documentamos equipes, membros de equipe, campos personalizados, webhooks e aprovação de horas.
• Lançamentos de horas agora documentam vínculo com atividade, pausas, referência externa, custo, imposto e campos personalizados. A edição em lote continua fora da documentação pública.
• Atividades documentam data de vencimento, subtarefas, restauração e exclusão lógica. Listas de atividades documentam cor e restauração.
• Filtros do relatório detalhado que já funcionavam voltaram a ser publicados, inclusive campos personalizados e status de faturamento.
• Respostas de um único registro passam a ser documentadas dentro de { "data": ... }.
• Incluída a cota do plano Ultimate: 2.500 requisições por dia.
• Documentamos tags de atividades, taxas, comentários, calendários e feriados, folgas e férias, histórico de calendário, foto de perfil, projetos do usuário e atribuições.
• GET /time-entries/current devolve o cronômetro ativo do usuário autenticado, ou data: null quando nenhum está em andamento.

2025-11-14

• 🎉 Lançamento público da API do RabbitWork — disponível para todos os clientes e integrações de terceiros.
  A API está oficialmente aberta para uso em produção, com documentação pública, autenticação e cotas por plano.
• Definidas cotas diárias por plano:
  • Free / teste / legado: 50 requisições por dia
  • Plus: 1 000 requisições por dia
  • Business: 5 000 requisições por dia (limite flexível)
  • Business Max: 25 000 requisições por dia (limite flexível)
• A documentação de GET /projects passou a incluir paginação.
• Novos filtros em GET /projects: id, active, customer_id.
• Novos filtros em GET /customers: id, active.
• Novos filtros em GET /users: id, active.
• Novos filtros em GET /tasks: id, active.

2025-11-12

• Introduzida a política de limite de uso por minuto, por conta, por IP e para autenticação.
• Headers padrão para acompanhar o limite: X-RateLimit-Minute, X-RateLimit-AccountDaily e Retry-After.
• Tratamento de erro mais claro quando o limite é ultrapassado, com códigos específicos e headers de aviso.

2025-07-11

• Descontinuado o endpoint GET /time-entries para listar lançamentos.
• Substituído por /reports/detailed, com mais filtros e capacidade de relatório.

2024-06-28

• Novos endpoints do módulo de atividades:
• /todos — gerenciar atividades e responsáveis
• /todo-lists — organizar atividades em listas

2024-01-09

• Cálculo automático de time_total ao criar um lançamento de horas, quando ele não é enviado, usando time_start e time_end quando existirem.
• Tratamento mais consistente de time_start, time_end e time_total. Quando só alguns campos de tempo são enviados, a API completa os outros — priorizando o tempo total, depois o início e por fim o fim. Isso evita durações divergentes e garante que o total de horas fique correto mesmo com dados parciais.

2023-02-11

• Primeira versão da documentação da API do RabbitWork, lançada em beta fechado para clientes selecionados.
• Endpoints iniciais de horas, usuários, projetos e clientes.
• Modelo de autenticação com tokens vinculados a um User-Agent específico.