Referral Marketing Software API
Connect referral data to your CRM and stack with the Mention Me API. Orders go in and segments come out. Then your CRM and ESP can target your most valuable advocates.
13
Years of referral intelligence
500+
Brands across every major ecommerce vertical
45k+
Experiments run across the network
About the Mention Me REST API
Enrols referrers, records orders, reads customer data and confirms reward eligibility
Auth, Merchant, Consumer and Entry Point
JSON over HTTPS
Production and demo
Mention Me is ISO 27001 certified and GDPR and PECR compliant. Trust and Security
Paid costs keep climbing. Your referral data sits in a silo.
Meta and Google CPAs are up 30 to 50% year on year, and your CAC target needs an owned channel to offset them. Referral should be that channel.
In-house referral tools plateau for the same reasons. Referral flows get stitched into the ESP with basic discount codes. Results live in a spreadsheet, and revenue is hard to attribute to advocacy.
An API puts referral data where your team already works.
How the Mention Me REST API works
Four steps take you from API key to live referral data.
- 1
Authenticate
Have an Administrator create an API key for the Merchant API, then swap it for a one-hour access token through the OAuth 2.0 client credentials flow. Entry Point and Consumer API requests use a separate authentication token. Build and test against the demo environment first.
- 2
Enrol customers and record orders
Send customer and order details through the Entry Point API, or the Consumer API if you want full control. Mention Me records the order and enrols the customer as an advocate where an offer applies. If the purchase came through a referral, it rewards the advocate under your programme rules.
- 3
Confirm eligibility
Tell Mention Me through the Merchant API when a referred customer meets your criteria, such as keeping a product or finishing a first month. You can flag cancellations the same way. Send up to 100 customers per request.
- 4
Read referral data
Call the Merchant API for customer profiles, Extended Customer Revenue segments, share counts by method and rewards issued through Mention Me.
How referrals get credited
Mention Me credits a recommendation when the referred customer converts after clicking a share link or entering the advocate's name or referral code at checkout. Entering a name is Name Share®, which captures in-person recommendations with no link needed. It needs each advocate's first and last name. You pass them, or advocates register their own.
Choose your build effort
We recommend the Entry Point API for most app integrations. It's the server-side alternative to our JavaScript tags and returns links to hosted web views, so you get our editing and branding tools without building a front end. The Consumer API takes significantly more development time than the Entry Point API or our JavaScript tags.
How much build effort does your stack need?
Book a demo and we'll show you which API fits. Once you're a customer, you get a dedicated CSM for hands-on support.
Book a demoWhy teams connect referral through the API
Referral results beside your other channels
Your team can pull referral share counts and rewards into reporting, next to your paid and retention data.
Segments your CRM can act on
Extended Customer Revenue segments sit on each customer record. allplants used referral data from its Klaviyo integration to build segments and saw a 5x increase in email engagement.
Intelligence on top of the data
Offer content served through the Entry Point API can be A/B tested. We've run 45,000+ experiments. Cross-brand benchmarks show you what good looks like.
Fraud controls built in
Gaming and velocity controls automatically flag suspicious activity to prevent double-dipping and fraud.
Connects to the tools you already run
We connect directly to the platforms below, and our API and webhooks cover almost any other customer platform. We also work with leading agencies who can handle the integration.
What teams do with referral data
15%
Wild cut paid social CPA by 15% with the Mention Me and Klaviyo integration.
9x
Gozney gets a 9x ROI from customer advocacy, with referral campaigns running in five markets. It connected Mention Me to Klaviyo to turn advocacy data into insight. Name Share® drives 58% of its referred customer acquisition.
The case study covers how Gozney puts that insight to work.
FAQs
Do I need a developer to use the API?
Yes. A developer builds the integration. We recommend the Entry Point API for most app integrations. It returns hosted web views and takes less development time than the Consumer API.
How long does the integration take to build?
It depends on your systems and which API you choose. Your developers can build and test in the demo environment before going live. Book a demo and we'll show you which API suits your stack.
How do I authenticate?
The Merchant API uses the OAuth 2.0 client credentials flow. An Administrator creates an API key, and your app exchanges it for a one-hour access token. Entry Point and Consumer API requests use a separate authentication token.
What data can I send and pull?
Send customer and order details, plus eligibility updates. Eligibility updates are queued and usually finish in under five minutes, though some take several hours. Pull customer profiles, segments, share counts and rewards issued through Mention Me.
Are there rate limits?
Only the Merchant API is rate limited. Its limit runs over a five-minute window, and exceeding it returns a 429 error. The Entry Point and Consumer APIs apply confidential anti-gaming controls that normal use is unlikely to trigger. If you hit the Merchant limit regularly, we can advise on request patterns or raise it.
Get referral data into your stack
Your CAC target needs an owned channel. Book a demo and we'll tailor it to your biggest challenges.
Book a demo