API Reference
The HealthCloud REST API follows OpenAPI 3.1 and is versioned at /v1. All endpoints are HIPAA-compliant and FHIR R4-native.
Install an SDK, authenticate, and make your first API call in under 5 minutes.
API key scopes, rotation, JWT tokens, and HIPAA audit logging.
Standardized error codes, retry logic, and troubleshooting guidance.
Try any endpoint live in your browser with your own API key.
Platform
FHIR R4 Resources
Rate Limiting
All API keys are subject to per-minute rate limits. Exceeding the limit returns a 429 Too Many Requests response. Use the Retry-After header value (in seconds) before retrying.
Starter
500 req/min · Burst: 50 req/s
Growth
2,000 req/min · Burst: 200 req/s
Enterprise
Custom · Burst: Custom
Rate limit headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Full error docs →
Object Model
IDs
Prefixed strings
org_01hx4f…, pat_demo_001
Timestamps
ISO 8601 UTC
2026-03-18T12:00:00Z
Nullability
Explicit null
"cursor": null
Pagination
Cursor-based
"cursor": "next_page_token"
FHIR bodies
application/fhir+json
R4 resource JSON
Versioning
URL path (/v1)
Breaking changes → /v2