---
title: "Service status"
method: GET
path: "/health"
tags: ["Service"]
---

# Service status

`GET /health`

## Request

- Base URL: `https://api.companystack.co.uk`
- URL: `https://api.companystack.co.uk/health`
- Auth: none required

Whether the API and its database are answering. No key needed and not counted against any limit. For incidents and planned work see https://status.companystack.co.uk.

## Response `200`

The service is up. `status` is `healthy`, or `degraded` when the database did not answer the check.

- object
  - `service` string, required
  - `version` string, required
  - `status` 'healthy' | 'degraded', required
  - `timestamp` string, date-time, required

---

[API](https://skmtc.dev/companystack/apis/companystack-api.md) · [All operations](https://skmtc.dev/companystack/apis/companystack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/companystack/apis/companystack-api/revisions/8f3234237d2d?raw)