---
title: "System health check"
method: GET
path: "/api/v1/internal/system-health/"
tags: ["Internal Admin"]
---

# System health check

`GET /api/v1/internal/system-health/`

## Request

- Base URL: `https://docs.thredfi.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.thredfi.com/api/v1/internal/system-health/`
- Auth: one of:
  - API key in cookie `sessionid`
  - HTTP basic
  - HTTP basic
  - HTTP bearer
  - HTTP bearer
  - none

Returns system health metrics

## Response `200`

- SystemHealth: Serializer for system health check
  - `status` string, required
  - `total_partners` integer, required
  - `total_businesses` integer, required
  - `total_users` integer, required
  - `database_status` string, required

---

[API](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api.md) - [All operations](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/revisions/0c1918254db3?raw)