Platform

HealthTasks REST API

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 read-only, developer-first layer for moving data across those boundaries without brittle exports.

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 for clinical education while data flows to downstream tools, institutional systems, and—where placements require it—clinical site partners with appropriately scoped credentials.

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

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.

{
  "data": [
    {
      "id": "8f2a1c3d-…",
      "date": "2026-03-15",
      "hours": 8,
      "status": "approved",
      "student": {
        "first_name": "Jordan",
        "last_name": "Lee",
        "email": "[email protected]"
      },
      "classroom": {
        "name": "NUR 412 — Acute Care Practicum"
      },
      "location": {
        "name": "Mercy General Hospital"
      },
      "preceptor": {
        "first_name": "Alex",
        "last_name": "Rivera"
      }
    }
  ],
  "next_cursor": null,
  "high_watermark": "2026-03-16T14:22:00Z"
}
Example: skills checkoff with per-step grades

Item-level assessment data includes AI and educator scores for each rubric step—not just a final pass/fail.

{
  "data": {
    "id": "c4e9b712-…",
    "status": "submitted",
    "mode": "graded",
    "student": {
      "first_name": "Jordan",
      "last_name": "Lee"
    },
    "template": {
      "name": "IV insertion — adult patient"
    },
    "grades": [
      { "step": "Hand hygiene", "score": 1, "source": "ai" },
      { "step": "Site preparation", "score": 1, "source": "educator" },
      { "step": "Catheter securement", "score": 0.5, "source": "ai" }
    ]
  }
}

The API is read-only and scoped to your institution. Access is included with all plans. Each key can only reach the resources 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. Compliance status lives in disconnected folders. 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. Partners receive only data for those sites—not your entire institution.

What site-scoped keys can access

  • Locations — Site details, active units, and contract expiration dates—without contract file downloads.

  • Site placements — Students scheduled at the authorized site(s), with segment dates, locations, and units.

  • Compliance statuses — Per-student compliance item status—document files are not included.

Example: site placement feed

Hospital partners see who is scheduled, on which unit, and for which dates—without access to the rest of your program.

{
  "data": [
    {
      "id": "classroom-uuid:student-uuid",
      "student": {
        "first_name": "Jordan",
        "last_name": "Lee"
      },
      "classroom": {
        "name": "NUR 412 — Acute Care Practicum"
      },
      "track": {
        "name": "Med-Surg Rotation A"
      },
      "segments": [
        {
          "start_date": "2026-01-06",
          "end_date": "2026-03-14",
          "location": { "name": "Mercy General Hospital" },
          "location_unit": { "name": "4 West — Medical Surgical" },
          "weekly_hours": 36
        }
      ]
    }
  ]
}
Example: compliance status

Sites can verify student readiness from status fields only—document files are never exposed through the API.

{
  "data": [
    {
      "user_id": "a91f0e44-…",
      "is_compliant": false,
      "student": {
        "first_name": "Jordan",
        "last_name": "Lee"
      },
      "items": [
        {
          "name": "TB screening",
          "status": "approved",
          "expiration_date": "2027-01-15"
        },
        {
          "name": "HIPAA attestation",
          "status": "approved"
        },
        {
          "name": "Annual flu vaccine",
          "status": "pending"
        }
      ]
    }
  ]
}

When a key covers multiple sites, partners can narrow results to a single location. That model lets hospitals and placement sites plug HealthTasks into their own workflows—placement feeds without spreadsheet handoffs, and a network that scales as you add partners.

Developer-first by design

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.

Example: paginated list shape

Most list endpoints return records, a cursor for the next page, and a high-watermark timestamp for incremental sync.

{
  "data": [
    {
      "id": "8f2a1c3d-…",
      "updated_at": "2026-03-16T14:20:00Z"
    }
  ],
  "next_cursor": "b7c3d912-…",
  "high_watermark": "2026-03-16T14:22:00Z"
}

Incremental sync

Paginated list endpoints and change filters make it straightforward to poll for updates or keep a data warehouse current—without re-exporting everything each term.

Rich, connected responses

Related students, classrooms, templates, and sites 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.

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.

Get started

Generate API keys in HealthTasks under Settings → REST API, then explore the documentation for authentication, endpoints, and examples.

View API documentationContact us