Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.example.com/health
{
  "status": "healthy",
  "service": "organization-api",
  "message": "API is running"
}

Response

200 - application/json

Successful Response

Health check response.

status
string
required

Service status

Example:

"healthy"

service
string
required

Service name

Example:

"organization-api"

message
string
required

Status message

Example:

"API is running"