Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mention-me.com/llms.txt

Use this file to discover all available pages before exploring further.

You may want to give referrers the ability to see the status of their referrals, the rewards they’ve earned, and encourage them to share again. The simplest way to do this is to provide a link or button in your app which takes the customer to a dashboard web view hosted by us.

Authentication

Our Dashboard endpoint requires an Authentication Token in the request. Click here to find out how to generate it.

How to add a link to the Referrer Dashboard

1

Call the Dashboard API

Call the Dashboard API passing parameters about the customer and the touchpoint. See the reference instructions for the Dashboard API.
2

Handle the response

If available, Mention Me returns a URL to the web view and a piece of text which you can use for the call to action.If we return an HTTP error code (e.g. 404) you should not show anything - the dashboard is not available for that customer, your account, or that touchpoint.
3

Return to app

When the user has finished using their dashboard they will close the web view to return to the app.
What’s Next View the Entry Point API reference
Last modified on March 31, 2026