REST API Access

The clearPath UI is one way to read the data. The clearPath REST API is the other. Every list, dashboard, and report you see in the browser is backed by a documented JSON endpoint that any modern integration tool can call — Power BI, Tableau, your data warehouse loader, your corporate scorecard, or a script your team writes in an afternoon.

The API uses token authentication, scoped to the same facilities and roles the calling user has in the application. There is no parallel authorization model to learn — if a user can see a unit in the UI, their token can read it through the API; if they can't, neither can the token. Multi-tenant boundaries hold across both surfaces.

Request for Information Compare Editions

Key Benefits

  • Documented JSON endpoints
  • Token authentication
  • Same scoping rules as the UI
  • Sessions, audits, and observations
  • Dashboard widget feeds
  • Report generation endpoints
  • Filterable by facility, unit, period
  • Pairs with HL7 FHIR R4 for interoperability

Example Request

A typical request fetches the compliance summary for a facility and time period in JSON:

GET /api/dashboard/compliance?facility=12&period=last30
Authorization: Bearer <your-token>
Accept: application/json

{
  "facility": "Mercy West — Cardiac Step-Down",
  "period": "last30",
  "compliance": 0.873,
  "observations": 1284,
  "target": 0.95,
  "by_moment": [
    { "moment": "before_patient_contact", "compliance": 0.81 },
    { "moment": "after_patient_contact",  "compliance": 0.94 }
  ]
}

The full endpoint reference, including request parameters and response schemas for sessions, audits, dashboards, reports, and configuration objects, ships with every Ultimate-edition deployment.

Integrate Anything. Break Nothing.

Available on Ultimate edition. Pair the REST API with HL7 FHIR R4 Support for healthcare-grade interoperability.

Request for Information Compare Editions