Your first integration
This guide takes you from credentials to your first patient: get an access token, verify your connection, and create a patient.Prerequisites
Before you begin, ensure you have:- Client credentials - a
client_idandclient_secretfor an app client, issued by your OpenLoop partnership team - HTTP Client - curl, Postman, or your preferred API testing tool
- Basic API Knowledge - Familiarity with RESTful APIs and JSON
1
Get an Access Token
The API uses the OAuth 2.0 client-credentials flow. Exchange your Response:
client_id and client_secret for a short-lived access token.2
Verify Your Connection
Confirm the token works with a simple authenticated read. Send the Expected Response: a
access_token as a Bearer token.200 with the standard list envelope.If you receive this response, your credentials are configured correctly and you’re ready to proceed.
3
Create Your First Patient
Create a patient record with all required demographic and contact information.
How Authentication Works
The Partners API authenticates every request with an OAuth 2.0 access token obtained through the client-credentials flow. There is no static API key.- Exchange your
client_id/client_secretatPOST /v0.1/auth/tokenfor anaccess_token. - Send that token on every request in the
Authorizationheader asBearer <access_token>. - Refresh the token before it expires (
expires_inseconds) and reuse it across requests in the meantime.
Your credentials map to an app client provisioned by OpenLoop, which determines what your integration can access. The platform authenticates and routes each request for you.
Next Steps
You’re ready to build your integration! Explore these resources to learn more.Partner Cookbook
Picks up here: the five calls that prove your tenant is provisioned, then intake
API Reference
Explore all available endpoints, parameters, and response schemas
Best Practices
Learn about error handling, data validation, and optimization techniques
Contact Support
Get help from our developer support team

