---
title: "Find a friend"
method: GET
path: "/api/consumer/{version}/referrer/search"
tags: ["Find referrer by name"]
---

# Find a friend

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

Search for a referrer by name (or email) to allow your customer to find their friend via NameShare.

If an exact match is found, we will return a 200 response. The 200 response will include the `referrerMentionMeIdentifier` and `referrerToken`. You should next collect the referee's details (i.e. their email address) and register them with the "Register referee" API. Completion of the registration with a valid email, `referrerMentionMeIdentifier` and `referrerToken` will allow the referee to gain their reward.

If no exact match is found, we will return a 404 response. A 404 may indicate we didn't find anyone, or it may indicate that we found multiple people with the same name. If we did find multiple people with the same name, we will also set the `foundMultipleReferrers` parameter in the root of the response to true.

If `foundMultipleReferrers` is set to true, the client should prompt the referee to narrow down the search, e.g. by entering the email address of the referrer. The exact narrowing strategy is up to the client.

## Path parameters

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

## Query parameters

- `name` string, required
- `email` string
- `request[partnerCode]` string, required
- `request[situation]` string, required
- `request[ipAddress]` string
- `request[localeCode]` string, required
- `request[userDeviceIdentifier]` string
- `request[deviceType]` string
- `request[appName]` string
- `request[appVersion]` string

## Response `200`

Returned when successful

- ReferrerFound
  - `referrer` ReferrerIdentifier
    - `referrerMentionMeIdentifier` integer
    - `referrerToken` string
    - `referrerOfferIdentifier` integer
    - `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
  - `foundMultipleReferrers` boolean
  - `links` ContentCollectionLink[]
    - `relationship` string
    - `resource` Content[]
      - `key` string
      - `content` string
  - `termsLinks` TermsLinks
    - `localeCode` string
    - `linkToTermsInLocale` string
  - `meta` object

## Other responses

- `403` — Returned when the integration for this merchant is not enabled
- `404` — Returned when it is not possible to find a match for this search
- `500` — The request contains errors
- `503` — The service was unavailable, try again shortly

---

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