Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://app.lettr.com/api/health
{
  "message": "Health check passed.",
  "data": {
    "status": "ok",
    "timestamp": "2024-01-15T10:30:00.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.lettr.com/llms.txt

Use this file to discover all available pages before exploring further.

Check the health status of the Lettr API. This endpoint does not require authentication and can be used for uptime monitoring or connectivity checks. Returns the current status and an ISO 8601 timestamp.

Response

200 - application/json

API is healthy

​
message
string
required
Example:

"Health check passed."

​
data
object
required