The Affiliate Manager Public API lets developers and Marketplace app builders manage a location's affiliate program programmatically. Through REST API endpoints, developers can work with affiliates, campaigns, referred customers, commissions, payouts, payout methods, and affiliate media without relying solely on the Affiliate Manager UI.
The API suite includes 28 new endpoints and 4 existing endpoints that were tightened, for 32 endpoints in total. It is available in the v3 API catalog on the HighLevel Developer Marketplace.
Key Capabilities
- Manage affiliates without the UI: Onboard, update, activate, and deactivate affiliates from your own app.
- Report on commissions and payouts: Pull commission and payout data into external dashboards, reconciliation, and finance workflows.
- Attribute conversions: Validate referral IDs and create leads from external landing pages and checkout flows to credit conversions to the right affiliate.
- Collect payout details in your own flow: Manage affiliate payout methods, including a lookup of the bank fields each country requires.
Who Can Use This Feature
Developers and agencies building custom dashboards, CRM integrations, automated reporting, or partner apps using Affiliate Manager.
API Endpoint Groups
All endpoints are available under /affiliate-manager and are organized into seven groups:
| Group | Endpoints | What you can do |
|---|---|---|
| Affiliates | 10 | Create, read, update, and list affiliates. Activate or deactivate an affiliate. Move an affiliate between campaigns. Set and validate referral IDs. Suspend an affiliate from a campaign. Upload a tax form. |
| Payout Methods | 6 | Create, read, update, and delete an affiliate's payout methods. Mark a payout method as primary. Look up the bank fields required for each country. |
| Commissions | 5 | Create, list, and delete commissions. Update commission status. Deny commissions. |
| Customers | 5 | List the customers an affiliate referred. Create and validate leads. Update a customer's state. Delete a customer. |
| Affiliate Media | 3 | List, update, and delete affiliate media files and folders for a location. |
| Campaigns | 2 | List campaigns and retrieve a campaign with its commission structure. |
| Payouts | 1 | List payouts for a location. |
Important API Behaviors
Before using the Affiliate Manager API, review these endpoint-specific behaviors:
- Creating affiliates: If an affiliate with the same email address already exists in a location, the Create Affiliate endpoint updates the existing affiliate instead of creating a duplicate.
- Updating affiliates: The Update Affiliate endpoint replaces the affiliate record. Fields omitted from the request body are cleared, so include all fields you want to retain.
- Referral IDs: Referral IDs must be unique within a location, even when affiliates belong to different campaigns.
- Suspending affiliates: Suspending an affiliate from a campaign cancels their pending and denied payouts, commissions, and transactions. Reinstating the affiliate returns canceled items to pending status.
- Payout methods: An affiliate can have one PayPal payout method and one bank payout method. The first method added becomes the primary method.
- Deleting payout methods: You cannot delete the primary payout method while the affiliate has more than one payout method.
- Payout information: The List Payout Methods endpoint returns only the last four characters of bank account values.
Refer to the Affiliates and Payout Methods API documentation for endpoint-specific requirements.
Authentication and Scopes
The APIs use standard v3 OAuth 2.0 with Location-Access. Two scopes control what your app can do:
- affiliate-manager.readonly: Required for the 12 endpoints that read data.
- affiliate-manager.write: Required for the 20 endpoints that create, update, or delete data.
How to Get Started
- Open the Affiliate Manager API v3 documentation in the HighLevel Developer Marketplace.
- Create or open your app in the Developer Marketplace and enable the affiliate-manager.readonly and/or affiliate-manager.write scopes, depending on what your app needs to do.
- Authorize your app for a location using OAuth 2.0 with Location-Access.
For instructions on registering an app, configuring OAuth settings, installing the app for a location, and obtaining access tokens, see the HighLevel OAuth 2.0 documentation. - Call the endpoints for the group you need. Each group has its own reference page with request and response details:
Common Use Cases
- Build a custom affiliate dashboard for your clients.
- Sync affiliates, commissions, and payouts with your CRM or finance tools.
- Onboard affiliates from your own signup flow, including collecting their payout details.
- Attribute leads and sales from external landing pages and checkout flows back to the right affiliate.
Frequently Asked Questions
Q: Do I need an app in the Developer Marketplace to use these APIs?
The APIs use v3 OAuth 2.0 with Location-Access, so your integration needs authorization for the location whose affiliate data it accesses.
Q: Where can I find request and response examples?
You can find examples in the Affiliate Manager section of the HighLevel API documentation linked above. Each endpoint group has its own reference page.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article