System

System-related endpoints

Get the health check

get

/v1/health-check

Returns the current health check status of the server, including checks for database.

Authorizations

AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Query parameters

Responses

200

Health check status response

application/vnd.api+json

400

Bad request.

application/vnd.api+json

401

Unauthorized.

application/vnd.api+json

429

Too many requests.

application/vnd.api+json

500

Internal Server Error.

application/vnd.api+json

503

Health check status response

application/vnd.api+json

get/v1/health-check

GET /pos/v1/health-check HTTP/1.1
Host: api.mews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "type": "healthChecks",
    "id": "current",
    "attributes": {
      "status": "ok",
      "timestamp": "2025-10-02T14:45:00Z"
    },
    "relationships": {
      "checks": {
        "data": [
          {
            "type": "checks",
            "id": "database"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "checks",
      "id": "database",
      "attributes": {
        "status": "ok"
      }
    }
  ]
}