System

Check API health

GET/v1/health

Tells you whether the API is working. It needs no key, so it suits uptime monitors. When something is wrong it answers 503 with the same shape.

Needs no key.

Response

200: The API is working.

Get a metric value

See how a value you sent was checked against your goal programs.

Get the OpenAPI document

This API as an OpenAPI 3.1 document.

curl "https://api.teambrite.com/v1/health"

{
  "status": "healthy",
  "timestamp": "2026-11-10T15:04:05.000Z",
  "services": {
    "database": "up"
  }
}