---
title: "Check API health"
method: GET
path: "/api/v1/health"
tags: ["meta"]
---

# Check API health

`GET /api/v1/health`

## Request

- Base URL: `https://justidea.agency`
- URL: `https://justidea.agency/api/v1/health`
- Auth: one of:
  - none
  - OAuth 2 (authorization code, authorization URL `https://justidea.agency/oauth/authorize/`, token URL `https://justidea.agency/oauth/token/`, scopes: `site:read`)

Whether the site catalog is loaded, with the number of pages. Returns 503 when the data is not available.

## Response `200`

Healthy.

- Health
  - `ok` boolean, required
  - `version` string, required
  - `pages` integer
  - `languages` string[]
  - `error` string

## Other responses

- `401`: The bearer token is invalid or expired (code invalid-token). Call without a token or get a new one.
- `429`: Rate limit exceeded (code rate-limited). Wait Retry-After seconds.
- `500`: Unexpected error (code internal-error). Retry later.
- `503`: Site data not available.

---

[API](https://skmtc.dev/justidea/apis/justidea-agency-public-api.md) · [All operations](https://skmtc.dev/justidea/apis/justidea-agency-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/justidea/apis/justidea-agency-public-api/revisions/83c8195ed800?raw)