Lumen Partners API¶
Welcome to the Lumen Partners API reference. This API lets approved partners integrate with Lumen for two purposes:
- Report purchases made on the partner's platform, optionally triggering Lumen-side fulfillment (device shipping).
- Receive daily user-level alerts generated by Lumen's analysis of consented users' metabolic and behavioral data.
Where to start¶
| If you want to... | Go to |
|---|---|
| Authenticate your requests | Authentication |
| Understand error formats and versioning | API Conventions |
| Report a purchase to Lumen | Purchases |
| Pull daily alerts for your enrolled users | Alerts |
| Look up alert subtypes and their meaning | Alert Types |
Base URL¶
Sandbox and production base URLs are provided during onboarding alongside your API key. All endpoints in this reference use a {baseUrl} placeholder; substitute your environment's base URL when making requests.
API access¶
Access and per-partner permissions (which alert types are enabled, whether fulfillment is available, audience-segment values) are configured during onboarding. If you need changes to your scope, contact your Lumen integration manager.