Read this page as a quick path: scan the headings, use the step blocks, and escalate if the expected result does not happen.
The Referral Factory REST API lets you programmatically manage your referral program — adding referrers, qualifying leads, and retrieving campaign data from your own systems.
Base URL
Authentication
All API requests require a Bearer token in the
Authorization header:Find your API Key in Campaign Settings → Integrations and API → API & Webhooks tab. Click Copy API Key to copy it to your clipboard.
Key concepts
- Every request that touches campaign data requires a
campaign_idparameter - Users (referrers and leads) have both an
id(internal Referral Factory ID) and anidentifier(email or code) - Some endpoints use
{id}in the URL, others use{identifier}— use the right one for each endpoint (see API documentation)
Core endpoints
GET /api/v2/users/{identifier}— retrieve a user by identifierPOST /api/v2/users— create a new referrer or leadPUT /api/v2/users/{id}— update a userPUT /api/v2/users/qualification— qualify or unqualify a leadDELETE /api/v2/users/{id}— delete a user
Rate limits
The Referral Factory API has a rate limit of 600 requests per minute. Exceeding this limit may result in temporary IP blocking. Implement proper caching and request throttling in your application to stay within the limit.
Full documentation and support
For the complete API reference, code examples, and integration guides, visit developers.referral-factory.com.
If you need assistance, contact developers@referral-factory.com.