Skip to main content
HealOS has no sandbox or test-mode keys yet. Every key works against production, and every call has real effects in the organization the key belongs to.

Test in a separate organization

Until a sandbox exists, build and test against a separate HealOS organization that holds only fake data:
  1. Create a second organization in the HealOS dashboard, for example “Acme Clinic (Test)”. Ask your HealOS contact if you need help.
  2. Create API keys in that organization (Account Settings → API Keys). A key only ever sees the organization it was created in, so a test key can’t read or change your real patients.
  3. Call GET /me first in every script and check that data.org.name is the test organization.
  4. Use clearly fake data: names like “Testy Quickstart”, a date of birth of 1970-01-01, phone numbers in the fictional 555-01xx range and external_id values starting with test-.

What still has real effects in a test organization

Eligibility checks

Payers only answer for real members, so there is no way to run a meaningful eligibility check on made-up data. A made-up member usually comes back as a payer error (422) or a “not found” issue, and can still be billed. Build and test the code that handles the response with the example response, then run a small number of real checks under your business associate agreement.