Check API health status

GET

/health

Verify that the API and its critical internal and external dependencies are operational. Use this endpoint for monitoring, load balancer health checks, and deployment validation.

This endpoint:

Checks database & cache connectivity

Checks Peakwork, Amadeus, Musement, etc. connectivity (if set-up for the project)

Returns "OK" if all systems are operational

Returns an error if any dependency is unavailable

Request

Authorization

Responses

🟢200OK

application/json

Health check successful - all systems operational

Bodyapplication/json

🔴500Server Error

Response Example

200 - All systems operational

{
    "Data": "OK",
    "Error": null
}

Modified at 2025-10-16 14:18:04

Environments

Get current API key context