---
title: "Get dashboard"
method: GET
path: "/api/consumer/{version}/referrer/dashboard"
tags: ["Get referrer dashboard"]
---

# Get dashboard

`GET /api/consumer/{version}/referrer/dashboard`

Get a referrer's dashboard (given a referrer identity, get their dashboard data).

If we respond with a 404 they are not a referrer. Instead, you should Enrol them as a referrer first, then call this endpoint again.

For information on how to correctly generate the Authentication Token, please see the documentation: https://docs.mention-me.com/api-reference/entry-point-api/authentication-token

## Path parameters

- `version` 'v2' | 'v1', required

## Query parameters

- `emailAddress` string, required
- `request[authenticationToken]` string, required
- `request[partnerCode]` string, required
- `request[situation]` string, required
- `request[ipAddress]` string
- `request[localeCode]` string
- `segment` string
- `uniqueCustomerIdentifier` string
- `request[userDeviceIdentifier]` string
- `request[deviceType]` string
- `request[appName]` string
- `request[appVersion]` string

## Response `200`

Returned when successful

- ReferralDashboardOffer
  - `offer` Offer
    - `id` integer
    - `localeCode` string
    - `headline` string — e.g. "You can get a £20 gift card if you refer a friend to ..."
    - `description` string — e.g. "Give your friends a 20% off introductory offer"
    - `callToAction` string — e.g. "Get a £20 gift card"
    - `privacyNotice` string — e.g. "Get a £20 gift card"
    - `privacyLink` string — e.g. "https://mention-me.com/help/privacy_policy"
    - `referrerReward` Reward
      - `description` string — The description we give may vary depending on the point in the flow that we choose to give it. Note that in some cases this might be "promising the reward" and in other cases "giving it". e.g. "You'll get £20 for each friend you refer" e.g. "Your friends get a free camera when they order for the first time" e.g. "A 20% discount code"
      - `summary` string
      - `amount` string
    - `refereeReward` Reward
      - `description` string — The description we give may vary depending on the point in the flow that we choose to give it. Note that in some cases this might be "promising the reward" and in other cases "giving it". e.g. "You'll get £20 for each friend you refer" e.g. "Your friends get a free camera when they order for the first time" e.g. "A 20% discount code"
      - `summary` string
      - `amount` string
  - `nameShare` NameShare
    - `name` string
    - `referralCode` string — Unique code this person can share with others to enter in the "Been referred by a friend?" section of your website.
  - `shareLinks` ShareLink[]
    - `type` string
    - `protocol` string
    - `url` string
    - `defaultShareMessage` string
    - `exampleImplementation` string
  - `termsLinks` TermsLinks
    - `localeCode` string
    - `linkToTermsInLocale` string
  - `referralStats` ReferralStats
    - `successfulReferrals` integer
    - `invitations` integer
    - `clicksOnInvites` integer
  - `referralRewards` DashboardReward[]
    - `description` string — The description we give may vary depending on the point in the flow that we choose to give it. Note that in some cases this might be "promising the reward" and in other cases "giving it". e.g. "You'll get £20 for each friend you refer" e.g. "Your friends get a free camera when they order for the first time" e.g. "A 20% discount code"
    - `summary` string
    - `amount` string
    - `status` string
    - `forReferring` object

## Other responses

- `204` — No content, when the customer does not have a dashboard to show. Try enrolling them as a referrer first.
- `400` — The request contains errors
- `403` — Returned when the integration for this merchant is not enabled
- `404` — Returned when it is not possible to serve a dashboard for this request
- `500` — Internal server error, unable to complete the request

---

[API](https://skmtc.dev/mention-me/apis/auth-api.md) · [All operations](https://skmtc.dev/mention-me/apis/auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mention-me/auth-api/revisions/cdad84f071bd/schema)