Platform API Reference
The vitalera REST API exposes 148 endpoints across 20+ resource groups, covering everything from vital sign ingestion to care plan lifecycle management. All endpoints return JSON and follow RESTful conventions with FHIR R5-aligned data models.
Full API documentation
The interactive API reference with request/response schemas, parameter details, and example payloads is available to customers in the vitalera dashboard. Contact info@vitalera.io for access.
Authentication & Users
| Group | Endpoints | Description |
|---|---|---|
| JWT Authentication | 4 | Generate, refresh, validate, and deactivate JWT tokens |
| Integration Authentication | 1 | SSO redirect for external identity providers |
| Credential Management | 1 | Rotate application client credentials |
| Users & Permissions | 1 | Current user permissions and role information |
Participants
| Group | Endpoints | Description |
|---|---|---|
| Monitoreds (Patients) | 10 | Create, list, update, delete participants. Export lists, retrieve summaries, manage care assignments, and query default plans. |
| Professionals | 5 | Create, list, update, delete healthcare professionals and care team members. |
| Monitoring Teams | 1 | List monitoring team members by plan definition. |
| Summaries | 1 | Aggregated counters across monitored participants. |
Care Plans & Tasks
| Group | Endpoints | Description |
|---|---|---|
| Plan Definitions | 11 | Manage plan templates — list, retrieve, publish, retire, revise. Query actions, app settings, organizations, profile fields, and validation status. |
| Monitored Plans | 26 | Full lifecycle management — create, activate, suspend, resume, complete, revoke. Manage monitoring team members, overrides, triggers, deviations, custom fields, and generate PDF reports. |
| Tasks | 10 | Manage clinical and wellness tasks — list, accept, start, complete, cancel, fail, reject. Pending task counters for dashboard badges. |
Observations — Vitals
| Group | Endpoints | Description |
|---|---|---|
| Blood Pressure | 2 | Systolic, diastolic, and mean arterial pressure |
| Heart Rate | 2 | Continuous and spot heart rate measurements |
| Oxygen Saturation (SpO2) | 2 | Pulse oximetry readings |
| Temperature | 2 | Body temperature measurements |
| Cholesterol | 2 | Total, LDL, HDL cholesterol panels |
Observations — Activity & Fitness
| Group | Endpoints | Description |
|---|---|---|
| Step Count | 2 | Daily and intraday step data |
| Calories | 2 | Active and total calorie expenditure |
| Distance | 2 | Distance covered (walking, running, cycling) |
| Floors Climbed | 2 | Elevation gain and floors |
| Active Minutes | 2 | Daily active minutes by intensity zone |
| Workouts | 2 | Structured workout sessions with laps, HR zones, pace |
| VO2 Max | 2 | Estimated maximal oxygen consumption |
Observations — Sleep & Recovery
| Group | Endpoints | Description |
|---|---|---|
| Sleep Sessions | 3 | Sleep duration, efficiency, and session metadata |
| Sleep Stages | 2 | Light, deep, REM, and awake stage breakdowns |
| Sleep Breathing | 2 | Breathing rate and disturbances during sleep |
| Stress Score | 2 | Daily stress levels and trends |
| Recovery Score | 2 | Post-exercise recovery readiness |
| Strain Score | 2 | Cardiovascular strain from activity |
| Energy Level | 2 | Body Battery / energy reserve levels |
Observations — Specialized
| Group | Endpoints | Description |
|---|---|---|
| Blood Glucose | 2 | Spot blood glucose readings |
| CGM Readings | 2 | Continuous glucose monitoring data points |
| CGM Summaries | 2 | Time-in-range, average glucose, variability |
| CGM Alerts | 2 | High/low glucose alert events |
| HRV | 2 | Heart rate variability (RMSSD, SDNN) |
| ECG | 2 | Electrocardiogram waveform data |
| Body Composition | 2 | Weight, body fat %, muscle mass, BMI |
| Skin Temperature | 2 | Continuous skin temperature readings |
| Peak Expiratory Flow | 2 | Asthma and COPD monitoring |
| Respiratory Rate | 2 | Breathing rate measurements |
| Spirometry | 2 | FEV1, FVC, and other lung function metrics |
| Mental Health | 4 | Mood state tracking and assessment scores |
Observations — General
| Group | Endpoints | Description |
|---|---|---|
| Data Quality | 1 | Quality metrics for observation data streams |
| FIT File Upload | 1 | Upload raw Garmin FIT files for processing |
| Garmin Sleep | 1 | Direct Garmin Sleep API data ingestion |
| Garmin Gaps | 1 | Identify gaps in Garmin data streams |
Questionnaires
| Group | Endpoints | Description |
|---|---|---|
| Questionnaires | 4 | List questionnaires, retrieve details, get items with translations (Accept-Language), and query responses. |
Alarms
| Group | Endpoints | Description |
|---|---|---|
| Detected Issues | 7 | Classify, cancel, or mark alarms as entered-in-error. Update classification details. Query triggered alarms. |
Appointments
| Group | Endpoints | Description |
|---|---|---|
| Appointments | 6 | Full scheduling lifecycle — book, check-in, fulfill, cancel, no-show, mark-error. |
Device Integrations
| Group | Endpoints | Description |
|---|---|---|
| Fitbit | 4 | Link/unlink Fitbit accounts, check link status, query last sync time. |
| Garmin | 1 | Direct Garmin data ingestion endpoints. |
Content
| Group | Endpoints | Description |
|---|---|---|
| Library | 1 | List educational and informational content resources. |
Base URL
https://api.vitalera.io/api/
Authentication
All endpoints require a valid JWT Bearer token. See Platform API Authentication.
Common Patterns
- Pagination — List endpoints return paginated results with
count,next, andpreviousfields. - Filtering — Most list endpoints support query parameters for filtering by status, date, and resource-specific fields.
- Translations — Resources with translatable content support the
Accept-Languageheader. - State transitions — Resources with lifecycles (tasks, plans, appointments, alarms) use dedicated
POST /{id}/{action}/endpoints. - Rate limits — See Rate Limits and Quotas.
Get Full Access
The interactive API reference with complete request/response schemas, parameter documentation, and a sandbox environment is available to customers. Contact us for credentials.