CountTogether Public API Help

Changelog

All notable changes to the CountTogether Public API documentation and surface are recorded here.

2026-04-13 - v2.0

Added

  • New v2 REST endpoint prefix with a flat counter response format: { id, name, type, value, startDate?, endDate?, created }.

  • GET /v2/counters and GET /v2/counters/{id} with optional ?timezone= parameter for timezone-aware value resolution.

  • POST /v2/counters/{id}/increment[/{amount}] and decrement[/{amount}] with optional custom amount (must be ≥ 1).

  • PATCH /v2/counters/{id} — type-gated partial updates: name (all types), value (UpDown only), startDate (FromDate only), endDate (ToDate only). Empty requests and inapplicable fields return 400.

  • New v2/ws?timezone= WebSocket endpoint with timezone-aware counter values in counterUpdated events.

  • New error code -2042 (InvalidAmount): returned when amount ≤ 0.

Deprecated

  • All v1 endpoints are deprecated with a sunset date of 2026-07-01.

  • Responses to /v1/ paths now include Deprecation: true, Sunset: Tue, 01 Jul 2026 00:00:00 GMT, and a Link successor header.

2026-02-28 - v1.1

  • Added endpoint: GET /v1/counters/{counterId}.

  • Added endpoint: PUT /v1/counters/{counterId}.

2025-09-30 - v1 Initial Public Release

  • Published first stable version of the Public API (/v1).

  • Added endpoint: GET /v1/counters.

  • Added WebSocket realtime events: counterUpdated, counterDeleted, counterMemberlistChanged.

  • Added unified error response model with numeric codes.

  • Introduced rate limiting policy (sliding window 120/min per user).

  • Provided data models for UpDown, FromDate, ToDate counter types.

21 April 2026