Quick Start Guide

1. Introduction

The Guardian Health API provides read-only access to clinical data synchronized from leading EHR platforms. Use it to build patient portals, clinical dashboards, and operational tools without managing direct EHR integrations.

2. Getting Your API Key

1. Sign in to the Guardian Health dashboard.
2. Navigate to Developers → API Keys.
3. Click Create key and choose a descriptive label (for example, Production Read Only).
4. Copy the generated key and store it in a secure location—Guardian Health will not show it again.

Tip: capture screenshots of your configuration for internal runbooks. Ensure that only authorized administrators can access the dashboard.

3. Making Your First Request

With an API key in hand, call the GET /api/v1/patients endpoint to list patients from your EHR connection. Authenticate requests with the Authorization: Bearer header.

curl "https://api.guardianhealth.dev/api/v1/patients?limit=5" \\\n  -H "Authorization: Bearer $GUARDIAN_API_KEY"

4. Understanding the Response

Guardian Health responses follow a consistent structure with a top-level data array and meta object containing pagination and source details.

• data – An array of patient objects containing demographics and identifiers.
• meta.limit and meta.offset – Use these for pagination.
• meta.source – Indicates the upstream system (Epic, Cerner, etc.).

5. Next Steps

You are now ready to explore deeper integrations. Continue with the guides below to implement best practices and domain-specific workflows.

• Authentication best practices
• Working with patient data
• Viewing encounters and visit timelines
• API Reference catalog
• API Playground for interactive testing