TOtotalpass
Health

Health Check

This endpoint performs a diagnostic check on the API service to ensure it is running correctly. It returns a simple status message indicating if the system is operational and ready to receive requests, useful for monitoring and heartbeat checks.

get/api/companies/v1/health

Request

  • Base URL
    https://hr.totalpass.com
  • URL
    https://hr.totalpass.com/api/companies/v1/health
  • Auth
    API key in header x-api-key

Response

returns http status :ok

statusstring

Example response

{
  "status": "ok"
}

Changes

No recorded changes to this operation across all 1 revision of this API.