Skip to main content
Endpoint Reference

GET /public/v1/health

Returns 200 ok with a server timestamp. Use as a reachability and auth-acceptance probe.

Reference

Method: GET Path: /public/v1/health Auth: Bearer marketplace token (any active install, any scopes) Tenant guard: not applicable (no :orgId/:entityId in path) Required scope: none Rate limit: counts against your standard 120/min budget

Request

curl -i -H "Authorization: Bearer $HB_TOKEN" \
  https://api.hellobooks.com/public/v1/health

Response

HTTP/1.1 200 OK
RateLimit-Limit: 120
RateLimit-Remaining: 119
RateLimit-Reset: 58
Content-Type: application/json
{ "ok": true, "ts": 1762800000000 }

ts is server-side milliseconds-since-epoch. Use it for round-trip latency or clock-skew detection — but do NOT use it as a transactional timestamp; use the timestamp on the resource itself for those.

When to use it

  • Pre-flight check before a batch of writes — confirm token + connectivity before consuming inventory.
  • Synthetic monitoring — schedule one health call per minute from your monitoring system to alert on connectivity loss.
  • CI smoke test — verify a newly-issued token works before running the rest of your test suite.
    API Reference: GET /public/v1/health