---
title: "Health check"
method: GET
path: "/health"
tags: ["Health"]
---

# Health check

`GET /health`

Returns the health status of the API and its dependencies

## Response `200`

All services are healthy

- HealthResponse
  - `ok` boolean, required — Overall health status - true if all checks pass
  - `service` string, required — Name of the service
  - `checks` object, required — Individual health checks for each service component
    - `api` HealthCheck, required
      - `ok` boolean, required — Health status of this component
      - `error` string — Error message if the check failed
    - `database` HealthCheck, required
      - `ok` boolean, required — Health status of this component
      - `error` string — Error message if the check failed

## Other responses

- `503` — One or more services are unhealthy

---

[API](https://skmtc.dev/amicalhq/apis/refref-api.md) · [All operations](https://skmtc.dev/amicalhq/apis/refref-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/amicalhq/refref-api/revisions/8edd0e1a3376/schema)