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.
GET
/
api
/
consumer
/
{version}
/
referrer
/
search
Find a friend
curl --request GET \
--url https://mention-me.com/api/consumer/{version}/referrer/search
Optionally ask the new customer to qualify the name with an email address belonging to the referrer. We typically ask for a Name first and then if no matches found, offer Name + Email address.
IP address of the customer connection. If you're making a request on behalf of a customer, pass their IP address here. If the customer will connect directly, leave this empty and we will retrieve this from their request.
This is used to hold a meta status code which is then used to pass a response back to the actual response later. · object
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Mention Me Docs","colors":{"primary":"#4C57E6","light":"#FF3EB5","dark":"#21174B"},"logo":{"light":"https://mintcdn.com/mentionme/V2LNKGCh7ROBia07/logo/light.svg?fit=max\u0026auto=format\u0026n=V2LNKGCh7ROBia07\u0026q=85\u0026s=747c8cd37a71a653a020675616c849f3","dark":"https://mintcdn.com/mentionme/V2LNKGCh7ROBia07/logo/dark.svg?fit=max\u0026auto=format\u0026n=V2LNKGCh7ROBia07\u0026q=85\u0026s=100c40618765923e52d9db84344692e6"},"favicon":"https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/favicon.ico?fit=max\u0026auto=format\u0026n=Dcv4Ct-ZIyuK4Pcd\u0026q=85\u0026s=cc9c8c8b015455ba82e2820c8306a4ab","background":{"color":{"light":"#FFFFFF","dark":"#22272E"}},"navbar":{"primary":{"type":"button","label":"Contact support","href":"https://help.mention-me.com/hc/en-gb/requests/new"}},"footer":{"socials":{"x":"https://x.com/mentionme","linkedin":"https://linkedin.com/company/mention-me"},"links":[{"header":"Company","items":[{"label":"Website","href":"https://www.mention-me.com"},{"label":"Platform","href":"https://app.mention-me.com"},{"label":"Support","href":"https://help.mention-me.com/hc/en-gb/requests/new"},{"label":"Status","href":"https://status.mention-me.com"}]}]},"seo":{"metatags":{"og:site_name":"Mention Me Docs"}},"errors":{"404":{"redirect":true,"title":"Page not found","description":"The page you're looking for may have moved. Try searching or head back to the [home page](/knowledge/getting-started/overview)."}},"contextual":{"options":["assistant","copy","claude","chatgpt","cursor","mcp","add-mcp"],"display":"toc"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Submit a Request","icon":"headset","href":"https://help.mention-me.com/hc/en-gb/requests/new"},{"anchor":"Platform","icon":"gauge","href":"https://app.mention-me.com"},{"anchor":"Status","icon":"signal","href":"https://status.mention-me.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mentionme","hasAudioNarration":false,"actualSubdomain":"mentionme","customDomains":["docs.mention-me.com"],"gitSource":{"type":"github","owner":"mention-me","repo":"mention-me-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af2019b0da5396f96340ce0","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Guides","count":365},{"language":"default","tag":"Integrations","count":73},{"language":"default","tag":"Referral","count":57},{"language":"default","tag":"Documentation","count":50},{"language":"default","tag":"API \u0026 Webhooks","count":45},{"language":"default","tag":"Customers","count":44},{"language":"default","tag":"Reporting","count":43},{"language":"default","tag":"Campaigns","count":42},{"language":"default","tag":"ESP \u0026 CRM Integrations","count":38},{"language":"default","tag":"Getting Started","count":32}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":".mm-partner-badge{padding:0 16px 8px;margin-bottom:10px}.mm-partner-badge-inner{display:flex;flex-wrap:wrap;gap:6px;align-items:center;padding:6px 10px;font-size:12px;line-height:1.3;color:#9ca3af;border:1px solid rgba(0, 0, 0, 0.07);border-radius:6px}.dark .mm-partner-badge-inner{border-color:rgba(255, 255, 255, 0.08)}.mm-partner-badge-content{min-width:0}.mm-partner-badge-context{color:#9ca3af}.dark .mm-partner-badge-context{color:#6b7280}.mm-partner-badge-name{font-weight:500;color:#6b7280}.dark .mm-partner-badge-name{color:#9ca3af}.mm-partner-badge-code{font-family:ui-monospace, SFMono-Regular, Menlo, monospace;color:#9ca3af}.dark .mm-partner-badge-code{color:#6b7280}.mm-partner-badge-reset{all:unset;flex-shrink:0;font-size:13px;line-height:1;color:inherit;cursor:pointer;opacity:0.3}.mm-partner-badge-reset:hover{opacity:0.7}.mm-partner-badge-switch{all:unset;flex-shrink:0;font-size:11px;line-height:1;color:#6b7280;text-decoration:underline;text-underline-offset:2px;cursor:pointer;opacity:0.8}.mm-partner-badge-switch:hover{opacity:1}.dark .mm-partner-badge-switch{color:#9ca3af}.mm-partner-badge-reenable{all:unset;color:#6b7280;text-decoration:underline;text-underline-offset:2px;cursor:pointer}.mm-partner-badge-reenable:hover{color:#4b5563}.dark .mm-partner-badge-reenable{color:#9ca3af}.dark .mm-partner-badge-reenable:hover{color:#d1d5db}pre code{width:auto!important;min-width:0!important;max-width:100%!important;padding:0!important;word-break:break-all!important;overflow-wrap:break-word!important;white-space:pre-wrap!important}body:has(.docs-home) #header,body:has(.docs-home) #page-title{display:none}body:has(.docs-home) #content-container,body:has(.docs-home) article,body:has(.docs-home) .prose{max-width:none}html:has(.docs-home){background-color:#ffffff}body:has(.docs-home){background:transparent}body:has(.docs-home) #background-color{background-color:#ffffff;background-image:radial-gradient(ellipse 120% 80% at 50% -10%, #c9cef8 0%, transparent 58%),\n radial-gradient(ellipse 70% 55% at 0% 30%, #f7cce8 0%, transparent 55%),\n radial-gradient(ellipse 60% 50% at 100% 15%, #d4d8f8 0%, transparent 50%);background-repeat:no-repeat}html.dark:has(.docs-home){background-color:#22272e}html.dark body:has(.docs-home){background:transparent}html.dark body:has(.docs-home) #background-color{background-color:#22272e;background-image:radial-gradient(ellipse 120% 80% at 50% -10%, #3d4280 0%, transparent 58%),\n radial-gradient(ellipse 70% 55% at 0% 30%, #5a3350 0%, transparent 55%),\n radial-gradient(ellipse 60% 50% at 100% 15%, #3a3f73 0%, transparent 50%);background-repeat:no-repeat}body:has(.docs-home) main,body:has(.docs-home) #content-container{min-height:100vh;background:transparent}.docs-home{width:100%;padding:0 1.25rem 5rem}.docs-home-inner{max-width:72rem;margin:0 auto}.docs-home-hero{max-width:1000px;padding:5.5rem 0 2.75rem;margin:0 auto;text-align:center}.docs-home-title{max-width:1000px;margin:0 auto 2.5rem;font-size:4rem;font-weight:600;line-height:4.5rem;color:#21174b;letter-spacing:-1px}.dark .docs-home-title{color:#f4f2fb}.docs-home-lede{margin:0;font-size:1rem;line-height:1.45;color:#5c5674}.docs-home-why{margin:1.15rem 0 0}.docs-home-why a{display:inline-flex;gap:0.45rem;align-items:center;padding:0.5rem 0.95rem 0.5rem 0.75rem;font-size:0.9rem;font-weight:500;line-height:1.2;color:#21174b;text-decoration:none;background:rgba(255, 255, 255, 0.72);border:1px solid rgba(33, 23, 75, 0.2);border-radius:999px}.docs-home-why a:hover{color:#4c57e6;border-color:#4c57e6}.docs-home-why a svg{width:1rem;height:1rem}.dark .docs-home-why a{color:#f4f2fb;background:rgba(34, 39, 46, 0.55);border-color:rgba(255, 255, 255, 0.2)}.dark .docs-home-why a:hover{color:#c5c9f8;border-color:#c5c9f8}.docs-home-platforms{max-width:650px;margin:0 auto}.docs-home-section-title{margin:3.5rem 0 1.75rem;font-size:1.75rem;font-weight:600;line-height:2.25rem;color:#21174b;text-align:center;letter-spacing:-0.5px}.dark .docs-home-section-title{color:#f4f2fb}.docs-home-topics{margin-top:0}.dark .docs-home-lede{color:#b4afc6}@media (max-width: 640px){.docs-home-title{font-size:2.5rem;line-height:2.85rem}}.cl-meta{display:flex;flex-wrap:wrap;gap:0.4rem 0.55rem;align-items:center;margin:0 0 1.25rem;font-size:0.8rem;font-weight:500;line-height:1.2;color:#5c5674}.cl-meta-date{font-variant-numeric:tabular-nums}.dark .cl-meta{color:#b4afc6}.cl-pill{display:inline-flex;align-items:center;padding:0.18rem 0.5rem;font-size:0.7rem;font-weight:600;line-height:1.2;letter-spacing:0.01em;border-radius:999px}.cl-pill-new{color:#4c57e6;background:rgba(76, 87, 230, 0.1)}.cl-pill-improved{color:#5c5674;background:rgba(33, 23, 75, 0.06)}.cl-pill-fixed{color:#8a2e6a;background:rgba(255, 62, 181, 0.1)}.cl-pill-area{color:#5c5674;background:transparent;border:1px solid rgba(33, 23, 75, 0.12)}.dark .cl-pill-new{color:#c5c9f8;background:rgba(76, 87, 230, 0.22)}.dark .cl-pill-improved{color:#d5d1e4;background:rgba(255, 255, 255, 0.06)}.dark .cl-pill-fixed{color:#f5b6dd;background:rgba(255, 62, 181, 0.16)}.dark .cl-pill-area{color:#d5d1e4;border-color:rgba(255, 255, 255, 0.14)}.cl-pill-platform-update{color:#21174b;background:rgba(76, 87, 230, 0.1)}.dark .cl-pill-platform-update{color:#c5c9f8;background:rgba(76, 87, 230, 0.22)}.cl-author{margin:0.85rem 0 0;font-size:0.875rem;font-weight:600;color:#21174b}.dark .cl-author{color:#f4f2fb}"}],"page":{"pagePath":"api-reference/find-referrer-by-name/find-a-friend","slug":"/api-reference/find-referrer-by-name/find-a-friend","pageMetadata":{"title":"Find a friend","description":"Search for a referrer by name (or email) to allow your customer to find their friend via NameShare.\n\nIf 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.\n\nIf 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.\n\nIf `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.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search","href":"/api-reference/find-referrer-by-name/find-a-friend","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Search for a referrer by name (or email) to allow your customer to find their friend via NameShare.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If an exact match is found, we will return a 200 response. The 200 response will include the \", _jsx(_components.code, {\n children: \"referrerMentionMeIdentifier\"\n }), \" and \", _jsx(_components.code, {\n children: \"referrerToken\"\n }), \". 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, \", _jsx(_components.code, {\n children: \"referrerMentionMeIdentifier\"\n }), \" and \", _jsx(_components.code, {\n children: \"referrerToken\"\n }), \" will allow the referee to gain their reward.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"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 \", _jsx(_components.code, {\n children: \"foundMultipleReferrers\"\n }), \" parameter in the root of the response to true.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If \", _jsx(_components.code, {\n children: \"foundMultipleReferrers\"\n }), \" 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.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Find a friend","description":"Search for a referrer by name (or email) to allow your customer to find their friend via NameShare.\n\nIf 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.\n\nIf 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.\n\nIf `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.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search","href":"/api-reference/find-referrer-by-name/find-a-friend","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/mentionme/585da3591117c76f/clerk-loader.js","/_mintlify/custom/mentionme/8c2fd5fe6a58ba82/posthog.js","/_mintlify/custom/mentionme/6b3953f5758cd5c3/tests/sftp-tree.js","/_mintlify/custom/mentionme/621493ede3850bd6/version-switch.js"],"openApiReferenceData":{"operation":{"tags":["Find referrer by name"],"summary":"Find a friend","description":"Search for a referrer by name (or email) to allow your customer to find their friend via NameShare.\n\nIf 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.\n\nIf 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.\n\nIf `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.","operationId":"get_api_name_search","parameters":["0a20de9c-c8ea-48a7-80e5-e56593100b23","c8b7b90b-b003-46ff-ad3d-06973d48dd8a","bd0e5b08-dec6-4aa0-8e8a-f260227a13f5","16c5302c-d416-46e6-8313-3ee10499ce28","d43eb067-aa5f-44c0-8894-e679e09596c4","876e1a46-5144-48e3-adb7-0969c6ae6dc1","c3624ca3-4fef-4991-9eb5-ab1a61ce840b","473b8b1b-4976-482b-bfaf-78e532f4ce57","7b38188e-cf08-4d57-83c8-ad69749d42c1","b417a07a-ff4e-46ff-a5e8-092d9095c8a1","5cebcf71-79c0-4a8a-a1f9-1de7a63b3481"],"responses":{"200":"628630c7-d44f-4706-80e8-3b683a429dbb","403":"5a55df54-6bc0-4e60-8ec1-b90e71518585","404":"fee2fd66-17b1-4f01-8d99-5e10c3e1a26f","500":"2c1b99e3-de11-4b28-906a-9268d6cba40a","503":"f36aa69d-6e45-43e9-8f98-5ce1bf8b5679"},"method":"get","type":"path","servers":["85b309c4-de7b-466a-a86c-f8e57d741243","e81a0b42-8815-4099-b02e-c848a5477c0f"],"security":[],"path":"/api/consumer/{version}/referrer/search","baseUrlOptions":["https://mention-me.com","https://demo.mention-me.com"],"title":"Find a friend","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0a20de9c-c8ea-48a7-80e5-e56593100b23":{"name":"version","in":"path","description":"Version","required":true,"schema":{"type":"string","pattern":"v2|v1","enum":["v2","v1"],"isRequired":true,"description":"Version","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"v2"},"c8b7b90b-b003-46ff-ad3d-06973d48dd8a":{"name":"name","in":"query","description":"Name of a referrer to search for (entered by the new customer)","required":true,"schema":{"type":"string","isRequired":true,"description":"Name of a referrer to search for (entered by the new customer)","uniqueKey":"","typeLabel":"string"},"example":"[REFERRERS-NAME]"},"bd0e5b08-dec6-4aa0-8e8a-f260227a13f5":{"name":"email","in":"query","description":"Optionally ask the new customer to qualify the name with an email address belonging to the referrer. We typically ask for a Name first and then if no matches found, offer Name + Email address.","required":false,"schema":{"type":"string","isRequired":false,"description":"Optionally ask the new customer to qualify the name with an email address belonging to the referrer. We typically ask for a Name first and then if no matches found, offer Name + Email address.","uniqueKey":"","typeLabel":"string"}},"16c5302c-d416-46e6-8313-3ee10499ce28":{"name":"request[partnerCode]","in":"query","description":"Your partner code, used to link to your users and offers","required":true,"schema":{"type":"string","isRequired":true,"description":"Your partner code, used to link to your users and offers","uniqueKey":"","typeLabel":"string"},"example":"[YOUR-PARTNER-CODE]"},"d43eb067-aa5f-44c0-8894-e679e09596c4":{"name":"request[situation]","in":"query","description":"Situation - a string representing where in the application you are making this request","required":true,"schema":{"type":"string","isRequired":true,"description":"Situation - a string representing where in the application you are making this request","uniqueKey":"","typeLabel":"string"},"example":"mobile-app"},"876e1a46-5144-48e3-adb7-0969c6ae6dc1":{"name":"request[ipAddress]","in":"query","description":"IP address of the customer connection. If you're making a request on behalf of a customer, pass their IP address here. If the customer will connect directly, leave this empty and we will retrieve this from their request.","required":false,"schema":{"type":"string","isRequired":false,"description":"IP address of the customer connection. If you're making a request on behalf of a customer, pass their IP address here. If the customer will connect directly, leave this empty and we will retrieve this from their request.","uniqueKey":"","typeLabel":"string"}},"c3624ca3-4fef-4991-9eb5-ab1a61ce840b":{"name":"request[localeCode]","in":"query","description":"Locale code - ISO standard locale code (e.g. en_GB) for the locale you expect the content to be in","required":true,"schema":{"type":"string","isRequired":true,"description":"Locale code - ISO standard locale code (e.g. en_GB) for the locale you expect the content to be in","uniqueKey":"","typeLabel":"string"}},"473b8b1b-4976-482b-bfaf-78e532f4ce57":{"name":"request[userDeviceIdentifier]","in":"query","description":"User Device Identifier should be a unique reference to this combination of app + user.","required":false,"schema":{"type":"string","isRequired":false,"description":"User Device Identifier should be a unique reference to this combination of app + user.","uniqueKey":"","typeLabel":"string"}},"7b38188e-cf08-4d57-83c8-ad69749d42c1":{"name":"request[deviceType]","in":"query","description":"Device type - your description of the device the user is using. We use this for performance and conversion optimisation.","required":false,"schema":{"type":"string","isRequired":false,"description":"Device type - your description of the device the user is using. We use this for performance and conversion optimisation.","uniqueKey":"","typeLabel":"string"}},"b417a07a-ff4e-46ff-a5e8-092d9095c8a1":{"name":"request[appName]","in":"query","description":"Your application name. Used for reporting.","required":false,"schema":{"type":"string","isRequired":false,"description":"Your application name. Used for reporting.","uniqueKey":"","typeLabel":"string"}},"5cebcf71-79c0-4a8a-a1f9-1de7a63b3481":{"name":"request[appVersion]","in":"query","description":"Your application version reference. Used for reporting and troubleshooting.","required":false,"schema":{"type":"string","isRequired":false,"description":"Your application version reference. Used for reporting and troubleshooting.","uniqueKey":"","typeLabel":"string"}}},"responses":{"628630c7-d44f-4706-80e8-3b683a429dbb":{"description":"Returned when successful","content":{"application/json":{"schema":{"properties":{"referrer":{"type":"object","title":"The primary payload of the response, assuming we found the referrer successfully. If we didn't this will be empty.","properties":{"referrerMentionMeIdentifier":{"title":"Our identifier for the referrer identified, the customer ID","type":"integer","uniqueKey":"referrer.referrerMentionMeIdentifier","typeLabel":"integer"},"referrerToken":{"title":"Token used to identify the referrer uniquely\n(flowId)","type":"string","uniqueKey":"referrer.referrerToken","typeLabel":"string"},"referrerOfferIdentifier":{"title":"Identify the Offer (i.e. this is an Offer Id)","type":"integer","uniqueKey":"referrer.referrerOfferIdentifier","typeLabel":"integer"},"offer":{"oneOf":[{"type":"object","title":"Description of the offer and rewards which this referrer is able to offer","properties":{"id":{"title":"The identifier of the offer.","type":"integer","uniqueKey":"referrer.offer.oneOf.0.id","typeLabel":"integer"},"localeCode":{"title":"The locale code of the Offer.","type":"string","uniqueKey":"referrer.offer.oneOf.0.localeCode","typeLabel":"string"},"headline":{"title":"The headline description for the Offer.","description":"e.g. \"You can get a £20 gift card if you refer a friend to ...\"","type":"string","uniqueKey":"referrer.offer.oneOf.0.headline","typeLabel":"string"},"description":{"title":"The details of the Offer.","description":"e.g. \"Give your friends a 20% off introductory offer\"","type":"string","uniqueKey":"referrer.offer.oneOf.0.description","typeLabel":"string"},"callToAction":{"title":"The callToAction text of the Offer - typically goes on the button of the offer","description":"e.g. \"Get a £20 gift card\"","type":"string","uniqueKey":"referrer.offer.oneOf.0.callToAction","typeLabel":"string"},"privacyNotice":{"title":"The privacyNotice text of the Offer - typically shown near the CTA if required by privacy regulation","description":"e.g. \"Get a £20 gift card\"","type":"string","uniqueKey":"referrer.offer.oneOf.0.privacyNotice","typeLabel":"string"},"privacyLink":{"title":"The URL to the Mention Me privacy policy - typically shown near the Privacy Notice.","description":"e.g. \"https://mention-me.com/help/privacy_policy\"","type":"string","uniqueKey":"referrer.offer.oneOf.0.privacyLink","typeLabel":"string"},"referrerReward":{"type":"object","title":"The explicit description of the Referrer Reward for the Referrer.","properties":{"description":{"title":"Friendly description of a reward for the intended recipient.","description":"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\".\n\ne.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\"","type":"string","uniqueKey":"referrer.offer.oneOf.0.referrerReward.description","typeLabel":"string"},"summary":{"title":"Summary - now deprecated - it serves no purpose over and above the description.","type":"string","uniqueKey":"referrer.offer.oneOf.0.referrerReward.summary","typeLabel":"string"},"amount":{"title":"The reward amount - now deprecated (because rewards don't have a consistent amount - some have text, percentage, number. Use the description to describe the reward.","type":"string","uniqueKey":"referrer.offer.oneOf.0.referrerReward.amount","typeLabel":"string"}},"uniqueKey":"referrer.offer.oneOf.0.referrerReward","typeLabel":"The explicit description of the Referrer Reward for the Referrer. · object"},"refereeReward":{"type":"object","title":"The explicit description of the Referee reward for the Referrer.","properties":{"description":{"title":"Friendly description of a reward for the intended recipient.","description":"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\".\n\ne.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\"","type":"string","uniqueKey":"referrer.offer.oneOf.0.refereeReward.description","typeLabel":"string"},"summary":{"title":"Summary - now deprecated - it serves no purpose over and above the description.","type":"string","uniqueKey":"referrer.offer.oneOf.0.refereeReward.summary","typeLabel":"string"},"amount":{"title":"The reward amount - now deprecated (because rewards don't have a consistent amount - some have text, percentage, number. Use the description to describe the reward.","type":"string","uniqueKey":"referrer.offer.oneOf.0.refereeReward.amount","typeLabel":"string"}},"uniqueKey":"referrer.offer.oneOf.0.refereeReward","typeLabel":"The explicit description of the Referee reward for the Referrer. · object"}},"uniqueKey":"referrer.offer.oneOf.0","typeLabel":"Description of the offer and rewards which this referrer is able to offer · object"},{"type":"null","uniqueKey":"referrer.offer.oneOf.1","typeLabel":"null"}],"uniqueKey":"referrer.offer","typeLabel":"Description of the offer and rewards which this referrer is able to offer · object | null"}},"uniqueKey":"referrer","typeLabel":"The primary payload of the response, assuming we found the referrer successfully. If we didn't this will be empty. · object"},"foundMultipleReferrers":{"title":"Whether the user should be prompted to narrow the search (by entering an email address for example)","type":"boolean","uniqueKey":"foundMultipleReferrers","typeLabel":"boolean"},"links":{"title":"Pagination of output and links to associated resources, including content-collection items.","type":"array","items":{"properties":{"relationship":{"title":"Relationship of the link between the two resources","type":"string","default":"content-collection","uniqueKey":"links.items.[INDEX].relationship","typeLabel":"string"},"resource":{"title":"The target resource being linked","type":"array","items":{"properties":{"key":{"title":"The content key","type":"string","uniqueKey":"links.items.[INDEX].resource.items.[INDEX].key","typeLabel":"string"},"content":{"title":"The content string","type":"string","uniqueKey":"links.items.[INDEX].resource.items.[INDEX].content","typeLabel":"string"}},"type":"object","uniqueKey":"links.items.[INDEX].resource.items.[INDEX]","typeLabel":"object"},"uniqueKey":"links.items.[INDEX].resource","typeLabel":"The target resource being linked · object[]"}},"type":"object","uniqueKey":"links.items.[INDEX]","typeLabel":"object"},"uniqueKey":"links","typeLabel":"Pagination of output and links to associated resources, including content-collection items. · object[]"},"termsLinks":{"type":"object","title":"Links to the terms and conditions for this offer.","properties":{"localeCode":{"title":"The locale code of the terms link","type":"string","uniqueKey":"termsLinks.localeCode","typeLabel":"string"},"linkToTermsInLocale":{"title":"Link to the terms and conditions in the locale stated","type":"string","uniqueKey":"termsLinks.linkToTermsInLocale","typeLabel":"string"}},"uniqueKey":"termsLinks","typeLabel":"Links to the terms and conditions for this offer. · object"},"meta":{"title":"This is used to hold a meta status code which is then used to pass a response back to the actual response later.","type":"object","additionalProperties":true,"uniqueKey":"meta","typeLabel":"This is used to hold a meta status code which is then used to pass a response back to the actual response later. · object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"referrer":{"referrerMentionMeIdentifier":123,"referrerToken":"\u003cstring>","referrerOfferIdentifier":123,"offer":{"id":123,"localeCode":"\u003cstring>","headline":"\u003cstring>","description":"\u003cstring>","callToAction":"\u003cstring>","privacyNotice":"\u003cstring>","privacyLink":"\u003cstring>","referrerReward":{"description":"\u003cstring>","summary":"\u003cstring>","amount":"\u003cstring>"},"refereeReward":{"description":"\u003cstring>","summary":"\u003cstring>","amount":"\u003cstring>"}}},"foundMultipleReferrers":true,"links":[{"relationship":"content-collection","resource":[{"key":"\u003cstring>","content":"\u003cstring>"}]}],"termsLinks":{"localeCode":"\u003cstring>","linkToTermsInLocale":"\u003cstring>"},"meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"5a55df54-6bc0-4e60-8ec1-b90e71518585":{"description":"Returned when the integration for this merchant is not enabled","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"fee2fd66-17b1-4f01-8d99-5e10c3e1a26f":{"description":"Returned when it is not possible to find a match for this search","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2c1b99e3-de11-4b28-906a-9268d6cba40a":{"description":"The request contains errors","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"f36aa69d-6e45-43e9-8f98-5ce1bf8b5679":{"description":"The service was unavailable, try again shortly","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"85b309c4-de7b-466a-a86c-f8e57d741243":{"url":"https://mention-me.com","description":"Production"},"e81a0b42-8815-4099-b02e-c848a5477c0f":{"url":"https://demo.mention-me.com","description":"Demo"}}},"originalFileLocation":"openapi/consumer_api.oas.json"},"subdomain":"mentionme","siteName":"Mention Me Docs","title":"Find a friend - Mention Me Docs","navMaps":{"firstHrefInVersion":{"Classic docs":{"href":"/api-reference/find-referrer-by-name/find-a-friend","matchLevel":0},"Mention Me docs":{"href":"/api-reference/find-referrer-by-name/find-a-friend","matchLevel":0}},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/find-referrer-by-name/find-a-friend.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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\u0026#x27;s details (i.e. their email address) and register them with the \u0026quot;Register referee\u0026quot; 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\u0026#x27;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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Mention Me Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Find a friend - Mention Me Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"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\u0026#x27;s details (i.e. their email address) and register them with the \u0026quot;Register referee\u0026quot; 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\u0026#x27;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.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mention Me Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mentionme.mintlify.site/_mintlify/api/og/v2?division=Find+a+friend\u0026amp;title=Find+a+friend\u0026amp;description=Search+for+a+referrer+by+name+%28or+email%29+to+allow+your+customer+to+find+their+friend+via+NameShare.%0A%0AIf+an+exact+match+is+found%2C+we+will+return+a+200+response.+\u0026amp;theme=52d9a28de14b1f3580df43c7\u0026amp;signature=8b8cac5a171170c9e8a0a7cebc04dab167ca3e897bdcffa036246fc76ae699f1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Find a friend - Mention Me Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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\u0026#x27;s details (i.e. their email address) and register them with the \u0026quot;Register referee\u0026quot; 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\u0026#x27;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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mentionme.mintlify.site/_mintlify/api/og/v2?division=Find+a+friend\u0026amp;title=Find+a+friend\u0026amp;description=Search+for+a+referrer+by+name+%28or+email%29+to+allow+your+customer+to+find+their+friend+via+NameShare.%0A%0AIf+an+exact+match+is+found%2C+we+will+return+a+200+response.+\u0026amp;theme=52d9a28de14b1f3580df43c7\u0026amp;signature=8b8cac5a171170c9e8a0a7cebc04dab167ca3e897bdcffa036246fc76ae699f1\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mention Me Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4C57E6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/find-referrer-by-name/find-a-friend.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.mention-me.com/#organization\",\"name\":\"Mention Me Docs\",\"url\":\"https://docs.mention-me.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mentionme/V2LNKGCh7ROBia07/logo/light.svg?fit=max\u0026auto=format\u0026n=V2LNKGCh7ROBia07\u0026q=85\u0026s=747c8cd37a71a653a020675616c849f3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.mention-me.com#website\",\"name\":\"Mention Me Docs\",\"url\":\"https://docs.mention-me.com\",\"publisher\":{\"@id\":\"https://docs.mention-me.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend#webpage\",\"url\":\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend\",\"name\":\"Find a friend\",\"description\":\"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.\",\"isPartOf\":{\"@id\":\"https://docs.mention-me.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Consumer API\",\"item\":\"https://docs.mention-me.com/api-reference/consumer-api/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Find a friend\",\"item\":\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend#apireference\",\"headline\":\"Find a friend\",\"name\":\"Find a friend\",\"description\":\"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.\",\"url\":\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend\",\"mainEntityOfPage\":{\"@id\":\"https://docs.mention-me.com/api-reference/find-referrer-by-name/find-a-friend#webpage\"},\"publisher\":{\"@id\":\"https://docs.mention-me.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.mention-me.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Mention Me Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Mention Me Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/find-referrer-by-name/find-a-friend.md","siteName":"Mention Me Docs","nav":{"global":{"anchors":[{"anchor":"Submit a Request","icon":"headset","href":"https://help.mention-me.com/hc/en-gb/requests/new"},{"anchor":"Platform","icon":"gauge","href":"https://app.mention-me.com"},{"anchor":"Status","icon":"signal","href":"https://status.mention-me.com"}]},"versions":[{"version":"Classic docs","default":true,"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/knowledge/getting-started/overview"}]},{"tab":"Documentation","icon":"code","pages":[{"title":"Documentation","href":"/developer-docs/integration/overview"}]},{"tab":"API \u0026 Webhooks","icon":"square-terminal","groups":[{"group":"Getting Started","pages":[{"title":"API Reference","sidebarTitle":"Overview","href":"/api-reference/introduction"},{"title":"Environments","href":"/api-reference/getting-started/environments"},{"title":"Errors","href":"/api-reference/getting-started/errors"},{"title":"Rate Limits","href":"/api-reference/getting-started/rate-limits"}]},{"group":"Auth API","pages":[{"title":"Authentication","href":"/api-reference/authentication/overview"},{"title":"Create an API Key","href":"/api-reference/authentication/create-api-key"},{"title":"Getting an Access Token","href":"/api-reference/authentication/access-token"},{"title":"Scopes","href":"/api-reference/authentication/scopes"},{"group":"Auth","pages":[{"title":"Get access token","deprecated":null,"version":null,"openapi":"/openapi/auth_api.oas.json post /api/oauth/token","href":"/api-reference/auth/auth/get-access-token"}]}]},{"group":"Merchant API","pages":[{"title":"Overview","href":"/api-reference/merchant-api/overview"},{"title":"Your First Merchant API Request","href":"/api-reference/merchant-api/first-request"},{"group":"Coupons","pages":[{"title":"Validate coupon code","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json get /api/merchant/v2/coupons/validate/{coupon_code}","href":"/api-reference/merchant/coupons/validate-coupon-code"}]},{"group":"Customers","pages":[{"title":"Get customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers","href":"/api-reference/merchant/customers/get-customers"},{"title":"Purge customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json delete /api/merchant/v2/customers","href":"/api-reference/merchant/customers/purge-customers"},{"title":"Lapse customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/lapse","href":"/api-reference/merchant/customers/lapse-customers"},{"title":"Get customer rewards","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/rewards","href":"/api-reference/merchant/customers/get-customer-rewards"}]},{"group":"Referee","pages":[{"title":"Referee cancellations","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/referee/cancellation","href":"/api-reference/merchant/referee/referee-cancellations"},{"title":"Referee eligibility","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/referee/eligibility","href":"/api-reference/merchant/referee/referee-eligibility"}]}]},{"group":"Entrypoint API","pages":[{"title":"Overview","href":"/api-reference/entry-point-api/overview"},{"group":"Referrer promotion","pages":[{"title":"Referrer Promotion","href":"/api-reference/entry-point-api/referrer-promotion"},{"title":"Enrol a customer in an offer","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/offer","href":"/api-reference/referrer/enrol-a-customer-in-an-offer"}]},{"group":"Referee integration","pages":[{"title":"Referee Integration","href":"/api-reference/entry-point-api/referee-integration"},{"title":"Find a friend by name","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/referee","href":"/api-reference/referee/find-a-friend-by-name"}]},{"group":"Referrer dashboard","pages":[{"title":"Referrer Dashboard","href":"/api-reference/entry-point-api/referrer-dashboard"},{"title":"Get dashboard","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/dashboard","href":"/api-reference/dashboard/get-dashboard"}]},{"title":"Authentication Token","href":"/api-reference/entry-point-api/authentication-token"},{"title":"PostMessage Iframe Events","sidebarTitle":"PostMessage Iframe","href":"/api-reference/entry-point-api/postmessage"}]},{"group":"Consumer API","pages":[{"title":"Overview","href":"/api-reference/consumer-api/overview"},{"group":"Order tracking","pages":[{"title":"Order Tracking","href":"/api-reference/consumer-api/order-tracking"},{"title":"Record order","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/order","href":"/api-reference/record-order/record-order"},{"title":"Record order with a coupon","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/coupon_redemption","href":"/api-reference/record-order/record-order-with-a-coupon"}]},{"group":"Enrol referrer","pages":[{"title":"Enrol referrer","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/referrer/enrol","href":"/api-reference/enrol-referrer/enrol-referrer"}]},{"group":"Referrer dashboard","pages":[{"title":"Get dashboard","description":"Get a referrer's dashboard (given a referrer identity, get their dashboard data).\n\nIf we respond with a 404 they are not a referrer. Instead, you should Enrol them as a referrer first, then call this endpoint again.\n\nFor 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","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/dashboard","href":"/api-reference/get-referrer-dashboard/get-dashboard"}]},{"group":"Find a friend","pages":[{"title":"Find a friend","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search","href":"/api-reference/find-referrer-by-name/find-a-friend"},{"title":"Find a friend content","description":"Fetch details from Mention Me with which to build a \"find a friend\" page. This will include an initial CTA, such as \"Been referred by a friend?\" as well as specific content which you can use to build the page.\n\nUsing this API to build your content will allow you to keep your content up to date with the latest content managed in Mention Me.\n\nYou should call this API once when your page is loaded, e.g. on the checkout page, and use it to populate the page.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search/content","href":"/api-reference/find-referrer-by-name/find-a-friend-content"}]},{"group":"Register referee","pages":[{"title":"Register referee","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/referee/register","href":"/api-reference/link-new-customer-to-referrer/register-referee"}]},{"group":"Product referral","pages":[{"title":"Track product page view for referral attribution.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/product/view","href":"/api-reference/track-product-page-view-for-referral-attribution"},{"title":"Track product share action.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/product/share","href":"/api-reference/track-product-share-action"}]}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/api-reference/webhooks/overview"},{"title":"Create Destination","sidebarTitle":"Create Destination","href":"/api-reference/webhooks/create-destination"},{"title":"Test a Webhook","sidebarTitle":"Test a Webhook","href":"/api-reference/webhooks/test-webhook"},{"title":"Disable or Delete a Webhook Connection","href":"/api-reference/webhooks/disable-webhook"},{"title":"Events","href":"/api-reference/webhooks/events"},{"title":"Security","href":"/api-reference/webhooks/security"},{"title":"FAQ","href":"/api-reference/webhooks/faqs"}]}]},{"tab":"Changelog","icon":"newspaper","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"version":"Mention Me docs","tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/knowledge-app/getting-started/overview"}]},{"tab":"Documentation","icon":"code","pages":[{"title":"Documentation","href":"/developer-docs/integration/overview"}]},{"tab":"API \u0026 Webhooks","icon":"square-terminal","groups":[{"group":"Getting Started","pages":[{"title":"API Reference","sidebarTitle":"Overview","href":"/api-reference/introduction"},{"title":"Environments","href":"/api-reference/getting-started/environments"},{"title":"Errors","href":"/api-reference/getting-started/errors"},{"title":"Rate Limits","href":"/api-reference/getting-started/rate-limits"}]},{"group":"Auth API","pages":[{"title":"Authentication","href":"/api-reference/authentication/overview"},{"title":"Create an API Key","href":"/api-reference/authentication/create-api-key"},{"title":"Getting an Access Token","href":"/api-reference/authentication/access-token"},{"title":"Scopes","href":"/api-reference/authentication/scopes"},{"group":"Auth","pages":[{"title":"Get access token","deprecated":null,"version":null,"openapi":"/openapi/auth_api.oas.json post /api/oauth/token","href":"/api-reference/auth/auth/get-access-token"}]}]},{"group":"Merchant API","pages":[{"title":"Overview","href":"/api-reference/merchant-api/overview"},{"title":"Your First Merchant API Request","href":"/api-reference/merchant-api/first-request"},{"group":"Coupons","pages":[{"title":"Validate coupon code","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json get /api/merchant/v2/coupons/validate/{coupon_code}","href":"/api-reference/merchant/coupons/validate-coupon-code"}]},{"group":"Customers","pages":[{"title":"Get customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers","href":"/api-reference/merchant/customers/get-customers"},{"title":"Purge customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json delete /api/merchant/v2/customers","href":"/api-reference/merchant/customers/purge-customers"},{"title":"Lapse customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/lapse","href":"/api-reference/merchant/customers/lapse-customers"},{"title":"Get customer rewards","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/rewards","href":"/api-reference/merchant/customers/get-customer-rewards"}]},{"group":"Referee","pages":[{"title":"Referee cancellations","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/referee/cancellation","href":"/api-reference/merchant/referee/referee-cancellations"},{"title":"Referee eligibility","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/referee/eligibility","href":"/api-reference/merchant/referee/referee-eligibility"}]}]},{"group":"Entrypoint API","pages":[{"title":"Overview","href":"/api-reference/entry-point-api/overview"},{"group":"Referrer promotion","pages":[{"title":"Referrer Promotion","href":"/api-reference/entry-point-api/referrer-promotion"},{"title":"Enrol a customer in an offer","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/offer","href":"/api-reference/referrer/enrol-a-customer-in-an-offer"}]},{"group":"Referee integration","pages":[{"title":"Referee Integration","href":"/api-reference/entry-point-api/referee-integration"},{"title":"Find a friend by name","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/referee","href":"/api-reference/referee/find-a-friend-by-name"}]},{"group":"Referrer dashboard","pages":[{"title":"Referrer Dashboard","href":"/api-reference/entry-point-api/referrer-dashboard"},{"title":"Get dashboard","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/dashboard","href":"/api-reference/dashboard/get-dashboard"}]},{"title":"Authentication Token","href":"/api-reference/entry-point-api/authentication-token"},{"title":"PostMessage Iframe Events","sidebarTitle":"PostMessage Iframe","href":"/api-reference/entry-point-api/postmessage"}]},{"group":"Consumer API","pages":[{"title":"Overview","href":"/api-reference/consumer-api/overview"},{"group":"Order tracking","pages":[{"title":"Order Tracking","href":"/api-reference/consumer-api/order-tracking"},{"title":"Record order","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/order","href":"/api-reference/record-order/record-order"},{"title":"Record order with a coupon","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/coupon_redemption","href":"/api-reference/record-order/record-order-with-a-coupon"}]},{"group":"Enrol referrer","pages":[{"title":"Enrol referrer","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/referrer/enrol","href":"/api-reference/enrol-referrer/enrol-referrer"}]},{"group":"Referrer dashboard","pages":[{"title":"Get dashboard","description":"Get a referrer's dashboard (given a referrer identity, get their dashboard data).\n\nIf we respond with a 404 they are not a referrer. Instead, you should Enrol them as a referrer first, then call this endpoint again.\n\nFor 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","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/dashboard","href":"/api-reference/get-referrer-dashboard/get-dashboard"}]},{"group":"Find a friend","pages":[{"title":"Find a friend","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search","href":"/api-reference/find-referrer-by-name/find-a-friend"},{"title":"Find a friend content","description":"Fetch details from Mention Me with which to build a \"find a friend\" page. This will include an initial CTA, such as \"Been referred by a friend?\" as well as specific content which you can use to build the page.\n\nUsing this API to build your content will allow you to keep your content up to date with the latest content managed in Mention Me.\n\nYou should call this API once when your page is loaded, e.g. on the checkout page, and use it to populate the page.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search/content","href":"/api-reference/find-referrer-by-name/find-a-friend-content"}]},{"group":"Register referee","pages":[{"title":"Register referee","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/referee/register","href":"/api-reference/link-new-customer-to-referrer/register-referee"}]},{"group":"Product referral","pages":[{"title":"Track product page view for referral attribution.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/product/view","href":"/api-reference/track-product-page-view-for-referral-attribution"},{"title":"Track product share action.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/product/share","href":"/api-reference/track-product-share-action"}]}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/api-reference/webhooks/overview"},{"title":"Create Destination","sidebarTitle":"Create Destination","href":"/api-reference/webhooks/create-destination"},{"title":"Test a Webhook","sidebarTitle":"Test a Webhook","href":"/api-reference/webhooks/test-webhook"},{"title":"Disable or Delete a Webhook Connection","href":"/api-reference/webhooks/disable-webhook"},{"title":"Events","href":"/api-reference/webhooks/events"},{"title":"Security","href":"/api-reference/webhooks/security"},{"title":"FAQ","href":"/api-reference/webhooks/faqs"}]}]},{"tab":"Changelog","icon":"newspaper","pages":[{"title":"Changelog","href":"/changelog"}]}]}]},"basePath":"","title":"Find a friend - Mention Me Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}