API Reference
API Reference Full reference for all OnePath Connect partner endpoints.
Try it interactively — the API Explorer lets you make live calls against the sandbox with your credentials.
Production: https://api.onepath.health Sandbox: https://sandbox.onepath.health All requests require two headers:
X-API-Key : onepath_production_<your-api-key> X-Consent-Assertion : <user-consent-jwt> See Authentication for details on generating consent tokens.
OnePath uses date-based versioning. Your integration is pinned to the version active at your BAA signing date. Breaking changes always ship under a new version date with at least 6 months notice.
Current stable version: 2026-07-21 · SDK 2.1.0
Method Path Description POST/partner/v1/users/onboardCreate a new user record PATCH/partner/v1/users/{id}/health-dataSubmit health observations (FHIR R4) GET/partner/v1/users/{id}/health-dataRetrieve all health data on file for a user
Method Path Description GET/partner/v1/users/{id}/insightsRetrieve AI-generated health summary GET/partner/v1/users/{id}/health-scoreRetrieve composite health score and domain breakdown GET/partner/v1/users/{id}/health-summaryRetrieve raw FHIR health summary with observations and conditions POST/partner/v1/users/{id}/lab-analysisProcess and extract structured data from a lab document POST/partner/v1/users/{id}/coaching-chatSend a message to the session-based health coaching AI
Method Path Description GET/partner/v1/users/{id}/lab-resultsList all lab results for a user GET/partner/v1/users/{id}/lab-results-pageRetrieve a paginated, filterable view of lab results GET/partner/v1/users/{id}/lab-results/{labId}Retrieve detailed information and AI analysis for a specific lab result
Method Path Description GET/partner/v1/users/{id}/goalsList active health goals POST/partner/v1/users/{id}/goalsCreate a new goal PATCH/partner/v1/users/{id}/goals/{goalId}Update goal progress PATCH/partner/v1/users/{id}/goals/{goalId}/progressRecord a progress data point for a goal POST/partner/v1/users/{id}/goals/{goalId}/coaching-chatSend a coaching chat message in the context of a goal
Method Path Description POST/partner/v1/users/{id}/chatSend a message in a user's general chat session GET/partner/v1/users/{id}/chat-historyRetrieve message history for a user's chat session. Optional ?sessionId= filters to a single session GET/partner/v1/users/{id}/chat-sessionsList all chat sessions for a user POST/partner/v1/users/{id}/resource-chatSend a chat message in the context of a specific resource
Method Path Description GET/partner/v1/users/{id}/documentsList all documents uploaded for a user POST/partner/v1/documents/{documentId}/analyzeTrigger AI analysis of an uploaded document POST/partner/v1/documents/{documentId}/chatSend a chat message in the context of a document
Method Path Description GET/partner/v1/users/{id}/demographicsRetrieve demographic and vitals data for a user PATCH/partner/v1/users/{id}/demographicsUpdate demographic and vitals data for a user
Method Path Description GET/partner/v1/users/{id}/fitness-plansList fitness plans for a user POST/partner/v1/users/{id}/fitness-plansCreate a new fitness plan PATCH/partner/v1/users/{id}/fitness-plans/{planId}/statusUpdate the status of a fitness plan POST/partner/v1/users/{id}/fitness-plans/{planId}/coaching-chatSend a coaching chat message in the context of a fitness plan
Method Path Description POST/partner/v1/users/{id}/product-advisor/chatSend a multi-turn chat message to the product advisor AI GET/partner/v1/users/{id}/product-advisor/sessionsList all product advisor sessions for a user DELETE/partner/v1/users/{id}/product-advisor/sessions/{sessionId}Close a product advisor session (soft-close — history is retained)
Method Path Description GET/partner/v1/usage/currentRetrieve current month's API usage for your partner account GET/partner/v1/usage/historyRetrieve historical usage data for your partner account
Wellvi medication lifecycle: order/refill creation, refill-due polling, progress check-ins, and
discontinue. Requires the medications.read/medications.write scopes. EHR sync is optional —
pass ehrPracticeConfigId on order creation only if you want that order synced into a practice's
EHR chart (Tebra today, more systems to follow); omit it to manage the order in OnePath only. See
the medication refill lifecycle guide for the end-to-end flow.
Method Path Description POST/partner/v1/users/{id}/medicationsCreate a medication order, or a refill when renewsOrderReference is set GET/partner/v1/users/{id}/medicationsList a patient's medication orders GET/partner/v1/medications/refills-dueList medications across your patient population due for a refill soon. Optional ?withinDays= sets the lookahead window (default 5, capped at 30) POST/partner/v1/users/{id}/medications/{orderId}/progress-checkinsSubmit a progress check-in form for a medication order GET/partner/v1/users/{id}/medications/{orderId}/progress-checkinsList progress check-ins submitted for a medication order PATCH/partner/v1/users/{id}/medications/{orderId}/discontinueClose the loop when a refill did not happen
Requires the conditions.read/conditions.write scopes. If your consent token carries an
acting_party claim (see Authentication ), the treating
clinician is recorded as a second agent on the underlying FHIR Provenance record alongside your
organization.
Method Path Description POST/partner/v1/users/{id}/conditionsRecord a condition for a user GET/partner/v1/users/{id}/conditionsList a patient's conditions
Code Meaning 401Invalid or expired API key or consent token 403Action not permitted for this partner scope 404User not found 409User already onboarded with this externalId 422Validation error — see details in response body 429Rate limit exceeded — see Retry-After header 5xxOnePath server error — safe to retry with exponential backoff
Environment Limit Sandbox 1,000 requests/minute Production 100 requests/minute
Rate limit headers are included on every response:
X-RateLimit-Limit : 100 X-RateLimit-Remaining : 87 X-RateLimit-Reset : 1722768000