Skip to main content
GET
/
api
/
v2
/
health
Public API v2 health check
curl --request GET \
  --url https://api.example.com/api/v2/health
{
  "data": {
    "status": "<string>"
  }
}

Response

Successful Response

Response envelope for GET /api/v2/health.

The shape mirrors the public-API single-record envelope (data: payload) so every documented /api/v2 response shares a uniform top-level structure. The inner HealthStatus is dedicated to this endpoint rather than reusing common.envelope.SingleResponse, which is record-typed (id / record_type / attributes) and does not fit a liveness payload.

​
data
PublicV2HealthStatus · object
required

Inner payload for the health response envelope.