Introduction
The OpenLoop Partners API is the clinical backend for consumer health. A single RESTful API carries a patient through the full journey: enrollment, intake, licensed clinical review, and every refill after. You keep your funnel, your design, and your customer relationship. We run the regulated clinical layer across weight management, sexual health and hair. You do not orchestrate the workflow. You start it with a few calls and read what happened: a patient was approved, a subscription activated, a prescription was written, an order shipped. Webhook delivery is configured per customer today, so build the synchronous reads first — see Events.The patient journey
The same journey runs behind every program. You touch the stages that face your customer; the platform runs the clinical stages for you.1
Launch programs and products
Define the programs you offer and the products and pricing behind them.
2
Check availability
Confirm a program can serve the patient before checkout.
3
Collect intake
Render the program questionnaire and submit the patient’s responses.
4
Clinical decision
A licensed provider reviews the intake. The platform returns eligibility and, when cleared, a prescription.
5
Enroll and subscribe
Eligible patients enter the clinical relationship and a recurring plan.
6
Fulfill and refill
Orders ship, and the refill cycle keeps treatment flowing.
7
Operate
Notifications and audit history keep you and the patient informed; read order state from the API.
Core Capabilities
Patient Management
Create, retrieve, update, and manage patients and related persons, and manage consents
Scheduling
Search provider availability, reserve a slot while the patient confirms, then book, reschedule, or cancel the appointment
Clinical Data
Exchange encounters, observations, allergies, and clinical documents
Orders & Labs
Submit lab requisitions, and track order status
Integration Workflow
The happy path is a handful of API calls. Start the journey, then read what happened.1
Verify API Connection
Test your credentials and confirm connectivity by listing patients.
You should receive a 200 status code with a paginated response envelope.
2
Enroll and collect intake
Create the patient and submit the intake responses your funnel already gathered. We attach them to the clinical review.
3
Read status
Read order state from the API. Webhook delivery is configured per customer today and is not self-serve.
Data Standards
The API enforces strict data formatting and validation rules to ensure consistency and reliability. Review our comprehensive Data Standards guide for:- Field format requirements and validation patterns
- Date, phone, and email formatting rules
- Address and location data structures
- Complete examples for all field types
Authentication
The Partners API uses the OAuth 2.0 client credentials flow (machine-to-machine). There is no static API key: you exchange yourclient_id and client_secret for a short-lived access token, then send that token as a Bearer token on every request.
1. Get your credentials
Yourclient_id and client_secret identify an app client that OpenLoop provisions for you during onboarding. Contact your OpenLoop partnership representative to have one issued.
2. Exchange credentials for a token
audience is a fixed identifier, not the host you call, and differs by environment — see Obtain a service token for more details.
data envelope and is short-lived (expires_in is in seconds):
3. Call the API
Send theaccess_token as a Bearer token on every request. Cache it and refresh before it expires rather than requesting a new one per call.
The OpenLoop platform authenticates your credentials and routes each request for you.
Response Format
All API responses follow a consistent JSON structure and include arequest_id for traceability. List endpoints return a paginated envelope with after/before cursors:
Walk until a response comes back with no after, not until a page comes back short. A cursor field is omitted when there is no page that way, so the presence of after is what “there is more” means. A full page can still be the last one, and a short page can still be followed by another — stopping on a short page ends the walk early and silently drops rows, with no error to point at. limit is a page size, not part of the cursor: the same walk works if you change it mid-way.
Need Help?
Quick Start
Token, first call, first patient
Best Practices
Error handling and optimization techniques
Contact Support
Reach the developer support team

