Grow LMS API Documentation
Grow by Plenum — Affiliates & Referral Programs
For organizations that drive enrollments through partners or referrals — affiliates, payouts, and lead attribution.
This is the most specialized document in the set, and it applies only if your program grows through partners, resellers, or referrals rather than direct sponsored enrollment. If that’s not your model, you can skip it. Where it is, Grow supports affiliate tracking, payouts, and lead attribution, covered here.
Every call uses the Pl-Client header and Authorization: Bearer <ACCESS_TOKEN> from Authentication & Access Setup. <SCHOOL_ID> is your environment.
1. Affiliates
An affiliate is a partner who drives enrollments and is credited for them. An Affiliate record extends a user with:
| Field | Description |
|---|---|
id / email / username / first_name / last_name |
The underlying user identity. |
code |
The unique affiliate code that attributes activity to this partner. |
paymentMethod |
How the affiliate is paid — paypal, bank_transfer, other, or none. |
paymentNotes |
Free-text payment notes. |
You can create affiliates, list them, and retrieve the customers and leads attributed to each.
2. Payouts
Affiliate earnings are tracked across three states, each separately queryable:
- Upcoming — earnings accruing but not yet due.
- Due — earnings owed and payable.
- Completed — payouts already made.
Pulling these lets you feed partner-payment reporting and reconcile what’s owed against what’s been paid.
3. Leads and attribution
A Lead is a captured prospect — someone who’s expressed interest but isn’t yet a full learner:
| Field | Description |
|---|---|
email / first_name / last_name |
Contact identity. |
tags |
Tags applied to the lead. |
subscribed_for_marketing_emails |
Marketing-consent indicator. |
created |
When the lead was captured (Unix timestamp). |
utms |
UTM attribution fields (e.g. first-click source), tying the lead back to the campaign or partner that generated it. |
UTM attribution travels on user and lead records, so you can trace an enrollment back to the channel or affiliate that drove it — the basis for crediting partners and measuring campaign performance.
4. How to think about it
- Niche by design. None of your core compliance data depends on this; it exists for partner/referral-driven growth models.
- If you run partners, the affiliate + payout + attribution data pulls into your partner-management and finance systems through the same patterns as the rest of the API.
- If you don’t, ignore this document — nothing else references it.
5. Where to go next
- Commerce & Monetization — the sales these referrals drive.
- Pull-Based Data Access — retrieving and paginating these records.
Prepared by Plenum Solutions for your evaluation. “Grow by Plenum” is operated and supported by Plenum on your behalf. Exact endpoint paths are confirmed for your environment during onboarding. For integration design support, contact your Plenum engagement lead.
