Skip to main content
GET
/
api
/
health
Health Check
curl --request GET \
  --url https://api.example.com/api/health
{
  "status": "healthy",
  "timestamp": "2025-02-25T12:00:00.000Z"
}
Public endpoint — no authentication required. Checks that the API server is running and can connect to the database.

Request

curl https://app.taxhomebase.com/api/health

Response

{
  "status": "healthy",
  "timestamp": "2025-02-25T12:00:00.000Z"
}
If the database is unreachable:
{
  "status": "unhealthy",
  "error": "Database connection failed"
}
This endpoint is exempt from rate limiting and authentication. It’s used for uptime monitoring and load balancer health checks.