Clinical education should interoperate with the systems your institution already runs—and with the hospitals and sites that host your students. The HealthTasks REST API is a developer-first layer for moving data across those boundaries without brittle exports or another portal for clinical partners.
Evaluations, skills checkoffs, clinical schedules, and student records often live in one place. SIS, LMS, CRM, and accreditation reporting live in another. Placement partners still receive rosters and schedule updates by email. Faculty and coordinators reconcile spreadsheets instead of supporting learners.
The REST API turns HealthTasks into connective infrastructure: your program keeps a single source of truth while data flows to downstream tools—and clinical site partners can pull who is coming with clearance and push unit capacity from the systems they already run.
Interoperability across your stack
The biggest payoff is interoperability. Institution-wide API keys expose a full catalog of clinical education data—rosters, schedules, logs, evaluations down to individual question responses, skills checkoffs down to per-step grades, placements, and compliance status—so your team can connect HealthTasks to student information systems, learning platforms, data warehouses, custom dashboards, and accreditation reporting pipelines.
Responses include related context—students, classrooms, templates, sites—so integrations stay efficient. Incremental sync support helps you pull only what changed instead of re-exporting everything each term.
What institution-wide keys can access
Rosters & scheduling
Students, preceptors, and active classrooms
Clinical schedule tracks, segments, and roster assignments
Clinical site locations with units and affiliation contract details
Placements & compliance
Site placements with segment dates, units, and weekly hours
Compliance statuses by student (approved, pending, rejected, expired, missing)
Experiential documentation
Clinical logs with student, preceptor, classroom, and site context
Evaluations
Evaluation templates, assignments, and completed evaluations
Individual questions and responses for item-level assessment data
Location evaluation insights with deidentified aggregate scores for Magnet and QI
Skills checkoffs
Skills checkoff templates, steps, assignments, and submissions
Per-step AI and educator grades, including practice and graded modes
Example: clinical log response
A single request returns the log plus embedded student, classroom, site, and preceptor—ready for your warehouse or dashboard.
Access is included with all plans. Each key can only reach the resources and sites it was issued for.
Site-scoped keys for clinical partners
Placements are where interoperability breaks down most often. Coordinators email rosters. Sites re-key schedules into another portal. Compliance status lives in disconnected folders. Unit capacity drifts out of sync. Everyone works from slightly different versions of the truth.
For clinical placements, administrators create site-scoped API keys under Settings → REST API, selecting the clinical sites a partner should see. HealthTasks meets those partners in their systems—pull who is coming and clearance, push unit capacity—instead of forcing another login.
What site-scoped keys can do
Locations & units — Site details and units with assigned_count and over_capacity for capacity planning—plus create, update, and archive units (name, description, capacity) with rest:write. Contract file downloads are not included.
Site placements — Who is scheduled at the authorized site(s), with segment dates, units, incremental sync (updated_since / high_watermark), and a clearance embed (is_compliant + blocking_items_count—no documents).
Compliance statuses — Per-student compliance item status—document files are not included.
Location evaluation insights — Deidentified aggregate scores for site-targeted evaluations—Magnet and QI signal without evaluator identity, comments, or raw rows. Scores are suppressed when count is under 5.
Example: site placement feed
GET /site_placements returns who is scheduled, on which unit, and clearance (is_compliant + blocking_items_count—no documents). Poll with updated_since using high_watermark to sync assignment changes.
GET /locations includes assigned_count and over_capacity on units—so partners can plan capacity before they write.
{
"id": "a91f0e44-…",
"name": "4 West — Medical Surgical",
"max_students": 4,
"assigned_count": 6,
"over_capacity": true
}
Example: update unit capacity
PATCH /location_units/{id} from the site’s own scheduler. Soft overbook: lowering max_students below assignments succeeds and sets over_capacity: true.
{
"max_students": 4
}
Example: location evaluation insights
Deidentified aggregates for site-targeted evaluations only. Scores are suppressed when count is under 5—no evaluator identity, comments, or raw rows.
When a key covers multiple sites, partners can narrow results to a single location. Schools keep HealthTasks as the system of record; hospitals keep working in the tools they already run—shared data, appropriate boundaries, no re-keying overnight.
Full OpenAPI documentation, standard API key authentication, and sensible rate limits for production use. List responses are paginated and include a change watermark so integrations can sync incrementally—the details live in the docs.
New: webhooks. Instead of only polling for changes, you can ask HealthTasks to notify your server when something important updates—placements, schedule edits, compliance status, or unit capacity. Configure an HTTPS endpoint under Settings → REST API; HealthTasks sends a thin event, and you pull the full record when you need it. Event types and delivery details are in the API documentation.
Example: paginated list shape
Most list endpoints return records, a cursor for the next page, and a high-watermark timestamp for incremental sync.
Optional push notifications from Settings → REST API. When placements, schedules, compliance, or unit capacity change, HealthTasks sends a short event to your HTTPS endpoint so your systems hear about it without constant polling. Treat webhooks as a heads-up, then fetch the full record through the API.
Incremental sync
Paginated list endpoints and change filters—including updated_since on site placements—make it straightforward to poll for assignment changes or keep a warehouse current without re-exporting everything each term. Pair with webhooks when you want faster notice of schedule and capacity edits.
Rich, connected responses
Related students, classrooms, templates, sites, and clearance summaries are included in responses so integrations stay efficient and readable.
Scoped API keys
Generate keys in HealthTasks under Settings → REST API. Institution-wide keys access the full catalog; site-scoped keys are limited to clinical sites you select. Write access for location units requires the rest:write scope (included on new keys by default). Site-scoped webhook endpoints only receive events for sites in scope.
Built for production integrations
OpenAPI-documented endpoints with standard API key authentication, rate limits, and documentation designed for secure server-side clients.
Sharing a site-scoped key with a clinical partner is at your institution's discretion—you are responsible for key custody and agreements that govern student information.
Related platform capabilities
Clinical data captured in HealthTasks is the same source Agents reason over and the same records available through the API.