CountTogether Public API Help

CountTogether Public API Overview

Welcome to the official CountTogether Public API documentation. This API allows you to access counters that belong to an authenticated user and receive realtime updates via WebSocket.

Base URL: https://developers.counttogether.app API Versioning: Current REST version path prefix: v1 (e.g. /v1/counters).

Playground

Test in Swagger

Feature Highlights

  • Retrieve your counters with a single endpoint.

  • Typed counter variants (UpDown, FromDate, ToDate).

  • Realtime server -> client push via WebSocket.

  • Bearer token authentication with per-user sliding window rate limiting.

  • Consistent, structured error responses with numeric codes.

Versioning Strategy

The API uses a path-based version: v1. Backwards compatible changes (adding optional properties) may occur without incrementing the major version. Breaking changes will introduce v2, keeping older versions available for a deprecation window.

Stability

The v1 surface is considered stable. Experimental additions will be marked explicitly inside their section.

Last modified: 01 October 2025