Where to find the API specification and runnable example collections.
API Specification
The full OpenAPI 3 specification powers the interactive API reference, where you can explore every endpoint, inspect the request and response schemas, and try requests directly in the browser.
Runnable examples
Healthily maintains healthily-api-examples, a Bruno collection containing every endpoint as an individual request plus end-to-end consultation scenarios with pre-filled answers.
Use the credentials we provided to fill partner_id, secret and api_key, then run the scenarios one request at a time or with the Bruno CLI:
npx bru run Scenarios -r --env Healthily-prod \
--env-var partner_id="$PARTNER_ID" \
--env-var partner_secret="$PARTNER_SECRET" \
--env-var api_key="$API_KEY"The requests in each scenario should be run in the order they are provided. Use them as guidelines for your implementation, and consider wiring them into your CI as a contract check.