Use the API Explorer
Every page in the API Reference includes an interactive panel that lets you execute real requests from your browser.
Steps
- Open an endpoint page — e.g. a practitioner search or facility lookup.
- Pick a server from the dropdown at the top of the request panel (see Environments).
- Authorize — paste your raw JWT (no
Bearerprefix) into the auth field. The token is kept in your browser's local storage only. - Fill in parameters — path, query, and header parameters each have labelled inputs; request bodies come pre-filled with an editable example.
- Send — the response (status, headers, body) renders inline. The panel also
shows equivalent
curl, Node.js, Python, and Java snippets you can copy.
Troubleshooting
| Symptom | Likely cause |
|---|---|
401 | Token expired or pasted with the Bearer prefix |
403 | Token lacks the RBAC permission for this endpoint |
| Network error / CORS failure | The target environment doesn't allow browser calls from this docs origin — use the generated curl snippet from a terminal instead, or ask the platform team to allowlist the docs origin in the API's CORS configuration |
Be careful in production
The explorer sends real requests. Prefer test or staging environments for anything that mutates data.