---
title: "Health Check"
method: GET
path: "/api/companies/v1/health"
tags: ["Health"]
---

# Health Check

`GET /api/companies/v1/health`

## Request

- Base URL: `https://hr.totalpass.com`
- URL: `https://hr.totalpass.com/api/companies/v1/health`
- Auth: API key in header `x-api-key`

This endpoint performs a diagnostic check on the API service to ensure it is running correctly. It returns a simple status message indicating if the system is operational and ready to receive requests, useful for monitoring and heartbeat checks.

## Response `200`

returns http status :ok

- object
  - `status` string

## Other responses

- `401`: returns unauthorized when api key is invalid

---

[API](https://skmtc.dev/totalpass/apis/api-companies.md) - [All operations](https://skmtc.dev/totalpass/apis/api-companies/llms.txt) - [OpenAPI document](https://skmtc.dev/totalpass/apis/api-companies/revisions/62259afde09a?raw)