REST API overview

Base URL

https://api.offinhealthcare.com/v1

Authentication

All API requests must include a valid JWT bearer token in the Authorization header:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Obtain a token via:

POST /v1/auth/login
Content-Type: application/json

{
  "email": "admin@hospital.com",
  "password": "your-password"
}

For machine-to-machine (gateway sync), use the license key header instead:

X-License-Key: your-gateway-license-key

Response format

All responses follow the standard envelope:

{
  "success": true,
  "data": { ... },
  "meta": { "page": 1, "total": 42 }
}

Error responses:

{
  "success": false,
  "error": "Invalid license key",
  "code": "LICENSE_INVALID"
}

Rate limits

Core endpoints