CountTogether Public API Help

GET /v1/counters

Returns an array of Counter objects.

Curl:

curl -H "Authorization: Bearer YOUR_TOKEN" https://developers.counttogether.app/v1/counters

Successful Response (200)

[ { "id": "018f5b54-9b11-7c33-b347-a2b4e2a6a111", "displayName": "Daily Steps", "type": "UpDown", "members": [ { "userId": "4f9b0c9d-9d3d-4f2b-9c97-5d6c3f0e4c11", "displayName": "You", "isAdmin": true } ], "data": { "value": 12450, "mode": "UpAndDown" } } ]

Empty Result

If the user owns or shares no counters, the endpoint returns [].

Authentication Errors

  • Missing / invalid token → 401 Unauthorized

Error Body (Business Errors)

Errors generated inside the pipeline use the structure documented in Errors.

Notes

  • No pagination yet (the typical number of counters per user is expected to be small). Pagination may be introduced later; treat additional unknown top-level fields as forward-compatible.

  • The endpoint is idempotent and safe.

Field Reference (Counter)

Field

Type

Description

id

string (UUID v7)

Unique counter identifier

displayName

string

Human readable name (5..40 chars)

type

enum UpDown \|FromDate \|ToDate

Counter category controlling data shape

members

array

Current member list (see Data Models)

data

object or null

Type-specific payload

See Counter Data Models for data shapes.~~~~

Last modified: 16 March 2026