Skip to content
Internal preview — Billtyme does not issue or send invoices yet.See what's included
Billtyme
Esc
navigateopen⌘Jpreview

Check API health

Returns a lightweight liveness response without contacting Postgres, WorkOS, or R2, so deploys and monitors can confirm that the API process is running.

GET/health
Responses
200Service is running
servicestringrequired
Allowed:billtyme-api
statusstringrequired
Allowed:ok
versionstringrequired
Allowed:0.1.0
Request
curl -X GET "/health"
Response
{
  "service": "billtyme-api",
  "status": "ok",
  "version": "0.1.0"
}