Lists the referrals a customer has sent, with each referral’s status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends’ emails are masked, since this list is meant to be shown to the referring customer. Paginated with page, size and sort; the total count is in the X-Total-Count response header.
GET
/
api
/
external
/
customer-referrals
Get a customer's referral history
curl --request GET \ --url https://loyalty-admin.appstle.com/api/external/customer-referrals \ --header 'X-API-Key: <x-api-key>'
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Appstle","colors":{"primary":"#0caceb","light":"#6ccdf2","dark":"#0a7eae"},"favicon":"https://mintcdn.com/appstleinc-aeca3e0a/811jRr2WFwD6kXFw/favicon.webp?fit=max\u0026auto=format\u0026n=811jRr2WFwD6kXFw\u0026q=85\u0026s=a98f329ae5c5ff4deaa241d8abe53f11","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","python","javascript","node","php","go","ruby"]}},"appearance":{"default":"light","strict":true},"navbar":{"primary":{"type":"button","label":"Help Center","href":"https://help.appstle.com/en/"}},"footer":{"socials":{"website":"https://appstle.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"appstleinc-aeca3e0a","hasAudioNarration":false,"actualSubdomain":"appstleinc-aeca3e0a","customDomains":["developers.appstle.com"],"gitSource":{"type":"github","owner":"appstleinc","repo":"appstle-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aecb6a5b20fc35bf6718b14","collectionId":"6081a1d1-0ca3-4510-b443-7b10efb73331","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aecb6a5b20fc35bf6718b14"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aed0473e4e9adf7c26adcd7","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"Subscriptions","count":268},{"language":"default","tag":"Storefront API","count":223},{"language":"default","tag":"Admin API","count":185},{"language":"default","tag":"Memberships","count":119},{"language":"default","tag":"Subscription Contracts","count":63},{"language":"default","tag":"Membership Contracts","count":62},{"language":"default","tag":"Loyalty","count":46},{"language":"default","tag":"Billing \u0026 Payments","count":28},{"language":"default","tag":"Bundles","count":24},{"language":"default","tag":"Subscription Management","count":24}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"vite-origin","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":"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":[],"page":{"pagePath":"loyalty-admin-api/referrals/get-a-customers-referral-history","slug":"/loyalty-admin-api/referrals/get-a-customers-referral-history","pageMetadata":{"title":"Get a customer's referral history","description":"Lists the referrals a customer has sent, with each referral's status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends' emails are masked, since this list is meant to be shown to the referring customer. Paginated with `page`, `size` and `sort`; the total count is in the `X-Total-Count` response header.","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json get /api/external/customer-referrals","href":"/loyalty-admin-api/referrals/get-a-customers-referral-history","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Lists the referrals a customer has sent, with each referral’s status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends’ emails are masked, since this list is meant to be shown to the referring customer. Paginated with \", _jsx(_components.code, {\n children: \"page\"\n }), \", \", _jsx(_components.code, {\n children: \"size\"\n }), \" and \", _jsx(_components.code, {\n children: \"sort\"\n }), \"; the total count is in the \", _jsx(_components.code, {\n children: \"X-Total-Count\"\n }), \" response header.\"]\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":"Get a customer's referral history","description":"Lists the referrals a customer has sent, with each referral's status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends' emails are masked, since this list is meant to be shown to the referring customer. Paginated with `page`, `size` and `sort`; the total count is in the `X-Total-Count` response header.","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json get /api/external/customer-referrals","href":"/loyalty-admin-api/referrals/get-a-customers-referral-history","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Lists the referrals a customer has sent, with each referral's status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends' emails are masked, since this list is meant to be shown to the referring customer. Paginated with `page`, `size` and `sort`; the total count is in the `X-Total-Count` response header.","operationId":"externalGetCustomerReferrals","parameters":["a55df78c-f282-4789-8ff4-68f331acf252","2154f125-409d-42ac-a195-93dd2184f41b","09a11f02-af99-454f-acb2-fda75c8ce0f2"],"responses":{"200":"2313c85c-2b4a-4144-837c-1477ff08d40b","400":"0b378021-eadb-480a-9aae-4f6b4fa3f54e","401":"2b0f5371-7ebb-40ca-9066-b49b6d5f2721"},"security":["c5d04d4d-d673-4fb2-af0a-77818ec4d4dd"],"summary":"Get a customer's referral history","tags":["Referrals"],"method":"get","type":"path","servers":["7ed27503-8296-44e8-8f2e-65be651bf96b"],"path":"/api/external/customer-referrals","baseUrlOptions":["https://loyalty-admin.appstle.com"],"title":"Get a customer's referral history","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","node","php","go","ruby"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a55df78c-f282-4789-8ff4-68f331acf252":{"description":"API key for authentication","in":"header","name":"X-API-Key","required":true,"schema":{"type":"string","isRequired":true,"description":"API key for authentication","uniqueKey":"","typeLabel":"string"}},"2154f125-409d-42ac-a195-93dd2184f41b":{"description":"Shopify customer ID of the referring customer","in":"query","name":"customerId","required":true,"schema":{"format":"int64","type":"integer","isRequired":true,"description":"Shopify customer ID of the referring customer","uniqueKey":"","typeLabel":"integer\u003cint64>"}},"09a11f02-af99-454f-acb2-fda75c8ce0f2":{"description":"Pagination parameters (page number, size, sort)","in":"query","name":"pageable","required":true,"schema":{"properties":{"page":{"format":"int32","minimum":0,"type":"integer","uniqueKey":"page","typeLabel":"integer\u003cint32>"},"size":{"format":"int32","minimum":1,"type":"integer","uniqueKey":"size","typeLabel":"integer\u003cint32>"},"sort":{"items":{"type":"string","uniqueKey":"sort.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"sort","typeLabel":"string[]"}},"type":"object","isRequired":true,"description":"Pagination parameters (page number, size, sort)","uniqueKey":"","typeLabel":"object"}}},"responses":{"2313c85c-2b4a-4144-837c-1477ff08d40b":{"content":{"application/json":{"schema":{"items":{"properties":{"createAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].createAt","typeLabel":"string\u003cdate-time>"},"customerId":{"format":"int64","type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].customerId","typeLabel":"integer\u003cint64>"},"referredEmailId":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].referredEmailId","typeLabel":"string"},"shop":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].shop","typeLabel":"string"},"status":{"enum":["PENDING","CLAIMED","RECURRING"],"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"claimAt":{"format":"date-time","type":"string","uniqueKey":"items.[INDEX].claimAt","typeLabel":"string\u003cdate-time>"},"description":{"type":"string","uniqueKey":"items.[INDEX].description","typeLabel":"string"},"id":{"format":"int64","type":"integer","uniqueKey":"items.[INDEX].id","typeLabel":"integer\u003cint64>"},"orderCount":{"format":"int32","type":"integer","uniqueKey":"items.[INDEX].orderCount","typeLabel":"integer\u003cint32>"},"pixelData":{"type":"string","uniqueKey":"items.[INDEX].pixelData","typeLabel":"string"},"referralNote":{"type":"string","uniqueKey":"items.[INDEX].referralNote","typeLabel":"string"},"referralRewarded":{"type":"boolean","uniqueKey":"items.[INDEX].referralRewarded","typeLabel":"boolean"},"referralRuleId":{"format":"int64","type":"integer","uniqueKey":"items.[INDEX].referralRuleId","typeLabel":"integer\u003cint64>"},"referredNote":{"type":"string","uniqueKey":"items.[INDEX].referredNote","typeLabel":"string"},"referredRewarded":{"type":"boolean","uniqueKey":"items.[INDEX].referredRewarded","typeLabel":"boolean"}},"required":["createAt","customerId","referredEmailId","shop","status"],"type":"object","uniqueKey":"items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"createAt":"2023-11-07T05:31:56Z","customerId":123,"referredEmailId":"\u003cstring>","shop":"\u003cstring>","status":"PENDING","claimAt":"2023-11-07T05:31:56Z","description":"\u003cstring>","id":123,"orderCount":123,"pixelData":"\u003cstring>","referralNote":"\u003cstring>","referralRewarded":true,"referralRuleId":123,"referredNote":"\u003cstring>","referredRewarded":true}]}},"exampleType":"generated"}},"description":"Successfully retrieved the customer's referrals","exampleType":"generated"},"0b378021-eadb-480a-9aae-4f6b4fa3f54e":{"description":"Invalid request - customerId is missing","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2b0f5371-7ebb-40ca-9066-b49b6d5f2721":{"description":"Unauthorized - Invalid or missing X-API-Key","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"c5d04d4d-d673-4fb2-af0a-77818ec4d4dd":{"X-API-Key":{"$ref":"3fdd1eae-fdd7-45d3-9385-e90d9d0dd06c","scopes":[]}}},"servers":{"7ed27503-8296-44e8-8f2e-65be651bf96b":{"url":"https://loyalty-admin.appstle.com"}}},"originalFileLocation":"loyalty/admin-api-swagger.json"},"subdomain":"appstleinc-aeca3e0a","siteName":"Appstle","title":"Get a customer's referral history - Appstle","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T22:34:45.875Z","originalFileLocation":"loyalty-admin-api/referrals/get-a-customers-referral-history.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Lists the referrals a customer has sent, with each referral\u0026#x27;s status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends\u0026#x27; emails are masked, since this list is meant to be shown to the referring customer. Paginated with page, size and sort; the total count is in the X-Total-Count response header.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Appstle\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_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/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_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/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_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/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_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/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_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/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_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/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_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/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a customer\u0026#x27;s referral history - Appstle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lists the referrals a customer has sent, with each referral\u0026#x27;s status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends\u0026#x27; emails are masked, since this list is meant to be shown to the referring customer. Paginated with page, size and sort; the total count is in the X-Total-Count response header.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Appstle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://appstleinc-aeca3e0a.mintlify.app/_mintlify/api/og/v2?division=Referrals\u0026amp;title=Get+a+customer%27s+referral+history\u0026amp;description=Lists+the+referrals+a+customer+has+sent%2C+with+each+referral%27s+status+%28PENDING%2C+CLAIMED%2C+RECURRING%29+and+whether+each+side+has+been+rewarded.+Friends%27+emails+are+\u0026amp;theme=f3911f4da205a97f19a260f1\u0026amp;signature=39a74670ffa8fffc762baa2f12b2b931e84138df8502eb65dcbe7230f19b1ace\">\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=\"Get a customer\u0026#x27;s referral history - Appstle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lists the referrals a customer has sent, with each referral\u0026#x27;s status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends\u0026#x27; emails are masked, since this list is meant to be shown to the referring customer. Paginated with page, size and sort; the total count is in the X-Total-Count response header.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://appstleinc-aeca3e0a.mintlify.app/_mintlify/api/og/v2?division=Referrals\u0026amp;title=Get+a+customer%27s+referral+history\u0026amp;description=Lists+the+referrals+a+customer+has+sent%2C+with+each+referral%27s+status+%28PENDING%2C+CLAIMED%2C+RECURRING%29+and+whether+each+side+has+been+rewarded.+Friends%27+emails+are+\u0026amp;theme=f3911f4da205a97f19a260f1\u0026amp;signature=39a74670ffa8fffc762baa2f12b2b931e84138df8502eb65dcbe7230f19b1ace\">\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/appstleinc-aeca3e0a/qTHqMufQccFjyOE2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Appstle\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0caceb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/loyalty-admin-api/referrals/get-a-customers-referral-history.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.appstle.com/#organization\",\"name\":\"Appstle\",\"url\":\"https://developers.appstle.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://developers.appstle.com#website\",\"name\":\"Appstle\",\"url\":\"https://developers.appstle.com\",\"publisher\":{\"@id\":\"https://developers.appstle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history#webpage\",\"url\":\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history\",\"name\":\"Get a customer's referral history\",\"description\":\"Lists the referrals a customer has sent, with each referral's status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends' emails are masked, since this list is meant to be shown to the referring customer. Paginated with page, size and sort; the total count is in the X-Total-Count response header.\",\"dateModified\":\"2026-11-05T22:34:45.875Z\",\"isPartOf\":{\"@id\":\"https://developers.appstle.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Admin API\",\"item\":\"https://developers.appstle.com/loyalty-admin-api/points-\u0026-earn-rules/add-store-credits-to-customer-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a customer's referral history\",\"item\":\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history#apireference\",\"headline\":\"Get a customer's referral history\",\"name\":\"Get a customer's referral history\",\"description\":\"Lists the referrals a customer has sent, with each referral's status (PENDING, CLAIMED, RECURRING) and whether each side has been rewarded. Friends' emails are masked, since this list is meant to be shown to the referring customer. Paginated with page, size and sort; the total count is in the X-Total-Count response header.\",\"url\":\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history\",\"mainEntityOfPage\":{\"@id\":\"https://developers.appstle.com/loyalty-admin-api/referrals/get-a-customers-referral-history#webpage\"},\"dateModified\":\"2026-11-05T22:34:45.875Z\",\"publisher\":{\"@id\":\"https://developers.appstle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.appstle.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Appstle\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Appstle","nav":{"global":null,"tabs":[{"tab":"Subscriptions","icon":"arrows-rotate","pages":[{"title":"Subscriptions","href":"/subscription/introduction"}]},{"tab":"Loyalty","icon":"star","groups":[{"group":"Get started","pages":[{"title":"Appstle Loyalty: Points, VIP Tiers \u0026 Referrals","sidebarTitle":"Introduction","href":"/loyalty/introduction"},{"title":"Authenticate with the Appstle Loyalty API","sidebarTitle":"Authentication","href":"/loyalty/authentication"},{"title":"Get started with Appstle Loyalty API","sidebarTitle":"Quickstart","href":"/loyalty/quickstart"}]},{"group":"Backend integration","pages":[{"title":"Appstle Loyalty third-party integration guide","sidebarTitle":"Integration guide","href":"/loyalty/integration-guide"},{"title":"Appstle Loyalty webhook events and setup","sidebarTitle":"Webhooks","href":"/loyalty/webhooks"},{"title":"Automate loyalty with Shopify Flow","sidebarTitle":"Shopify Flow","href":"/loyalty/shopify-flow"}]},{"group":"Storefront integration","pages":[{"title":"Shopify metafields and tags for Appstle Loyalty","sidebarTitle":"Metafields \u0026 tags","href":"/loyalty/metafields-and-tags"}]},{"group":"Partner integration","pages":[{"title":"Partner Integration Framework overview","sidebarTitle":"Framework overview","href":"/loyalty/partner-framework-overview"},{"title":"Partner Integration Framework","sidebarTitle":"Partner integration","href":"/loyalty/partner-integration"}]},{"group":"Resources","pages":[{"title":"Appstle Loyalty API changelog","sidebarTitle":"API changelog","href":"/loyalty/api-changelog"}]},{"group":"Admin API","pages":[{"group":"Points \u0026 Earn Rules","pages":[{"title":"Add store credits to customer account","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json post /api/external/add-credits","href":"/loyalty-admin-api/points-\u0026-earn-rules/add-store-credits-to-customer-account"},{"title":"Add points to customer account","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json post /api/external/add-points","href":"/loyalty-admin-api/points-\u0026-earn-rules/add-points-to-customer-account"},{"title":"Approve pending point transactions","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json put /api/external/approve-pending-transactions","href":"/loyalty-admin-api/points-\u0026-earn-rules/approve-pending-point-transactions"},{"title":"Get all point earning rules","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json get /api/external/point-earn-rules","href":"/loyalty-admin-api/points-\u0026-earn-rules/get-all-point-earning-rules"},{"title":"Get customer point transaction history","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json get /api/external/point-transaction-history/{customer_id}","href":"/loyalty-admin-api/points-\u0026-earn-rules/get-customer-point-transaction-history"},{"title":"Remove points from customer account","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json post /api/external/remove-points","href":"/loyalty-admin-api/points-\u0026-earn-rules/remove-points-from-customer-account"},{"title":"Get top customers by points earned","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json get /api/external/top-customers","href":"/loyalty-admin-api/points-\u0026-earn-rules/get-top-customers-by-points-earned"}]},{"group":"Redemptions \u0026 Discount Codes","pages":[{"title":"Check discount code validity","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json put /api/external/check-discount","href":"/loyalty-admin-api/redemptions-\u0026-discount-codes/check-discount-code-validity"},{"title":"Get all point redemption rules","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json get /api/external/point-redeem-rules","href":"/loyalty-admin-api/redemptions-\u0026-discount-codes/get-all-point-redemption-rules"},{"title":"Redeem customer points for rewards","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json post /api/external/redeem-points","href":"/loyalty-admin-api/redemptions-\u0026-discount-codes/redeem-customer-points-for-rewards"},{"title":"Update discount code status","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json put /api/external/update-discount","href":"/loyalty-admin-api/redemptions-\u0026-discount-codes/update-discount-code-status"},{"title":"Update discount code status (legacy endpoint)","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json put /api/external/update-discount-code-status","href":"/loyalty-admin-api/redemptions-\u0026-discount-codes/update-discount-code-status-legacy-endpoint"}]},{"group":"Customer Enrollment \u0026 Profile","pages":[{"title":"Get customer loyalty details","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json get /api/external/customer-loyalty","href":"/loyalty-admin-api/customer-enrollment-\u0026-profile/get-customer-loyalty-details"},{"title":"Enroll customer in loyalty program","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json post /api/external/enroll-customer","href":"/loyalty-admin-api/customer-enrollment-\u0026-profile/enroll-customer-in-loyalty-program"},{"title":"Update customer birth date","description":"Updates or sets a customer's birth date in the loyalty system. Used for birthday reward programs and customer segmentation. Send customerId and dob (YYYY-MM-DD). If you only know the month and day, send any year and set dobYearProvided to false. dob is required. When dobYearProvided isn't false, the year must be 1900 or later and the date can't be in the future. Invalid requests return 400 and leave the stored birth date unchanged. If the customer's birthday is today, any applicable birthday earn rule awards points right away.","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json put /api/external/update-customer-birth-date","href":"/loyalty-admin-api/customer-enrollment-\u0026-profile/update-customer-birth-date"}]},{"group":"Referrals","pages":[{"title":"Get a customer's referral history","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json get /api/external/customer-referrals","href":"/loyalty-admin-api/referrals/get-a-customers-referral-history"},{"title":"Accept a referral invite","description":"Records that a friend accepted a customer's referral invite. This is the Public API equivalent of the storefront\nwidget's referral claim, for headless storefronts that can't use the theme widget.\n\n**The headless referral flow:**\n1. Get the referring customer's link from `GET /api/external/customer-loyalty` (`referralLink`).\n2. The link lands on `https://\u003cstore>/?appstle_referral=true\u0026appstle_referral_code=\u003cTOKEN>`. Read\n `appstle_referral_code` from the landing URL, collect the friend's email, and send both here.\n3. For order-based referral programs, the referral completes when the friend places a qualifying order with that\n same email. No further API call is needed.\n4. Show the referring customer's referrals with `GET /api/external/customer-referrals`.\n\nCall this from your server. Never expose your API key in browser code.\n\n**Headless stores:** order-based referral rewards and referral emails need the Appstle app embed enabled in the\nstore's published Online Store theme, even when shoppers never see that theme.\n\n**What happens:**\n- The same checks as the storefront widget apply: invalid token, self-referral, an email that was already referred,\n an inactive referral program, and the referral program's customer-tag restrictions all return 400.\n- On success, a PENDING referral is created and any reward configured to be given on acceptance is issued.\n- Reward discount codes are not returned in the response (`discountCode` is always empty). They're emailed to each\n customer, and only when the Appstle app embed is enabled in the store's theme.\n- `existingCustomer` is true when the email already belongs to a store customer.\n- When no referral program is active, the 400 response's message reads \"Invalid request, token not found.\"\n","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json post /api/external/referral-accept","href":"/loyalty-admin-api/referrals/accept-a-referral-invite"}]},{"group":"Storefront Widgets \u0026 Labels","pages":[{"title":"List storefront widget label translations","deprecated":null,"version":null,"openapi":"/loyalty/admin-api-swagger.json get /api/external/widget-labels","href":"/loyalty-admin-api/storefront-widgets-\u0026-labels/list-storefront-widget-label-translations"}]}]},{"group":"Storefront API","pages":[{"group":"Referrals","pages":[{"title":"Generate customer referral URL","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/add-customer-referral-url","href":"/loyalty-storefront-api/referrals/generate-customer-referral-url"},{"title":"Get customer referral history","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json get /loyalty/cp/api/customer-referrals","href":"/loyalty-storefront-api/referrals/get-customer-referral-history"},{"title":"Accept referral offer (GET)","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json get /loyalty/cp/api/referral-rules/accept-offer","href":"/loyalty-storefront-api/referrals/accept-referral-offer-get"},{"title":"Accept referral offer (POST)","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/referral-rules/accept-offer","href":"/loyalty-storefront-api/referrals/accept-referral-offer-post"},{"title":"Send customer referral email","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/send-customer-referral-url","href":"/loyalty-storefront-api/referrals/send-customer-referral-email"}]},{"group":"Points \u0026 Earn Rules","pages":[{"title":"Claim social media reward points","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/claim-social-media-points","href":"/loyalty-storefront-api/points-\u0026-earn-rules/claim-social-media-reward-points"},{"title":"Track customer store visit","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/customer-visit-store","href":"/loyalty-storefront-api/points-\u0026-earn-rules/track-customer-store-visit"},{"title":"Get customer point transaction history","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json get /loyalty/cp/api/transaction-by-shop","href":"/loyalty-storefront-api/points-\u0026-earn-rules/get-customer-point-transaction-history"}]},{"group":"Customer Enrollment \u0026 Profile","pages":[{"title":"Get customer loyalty information","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json get /loyalty/cp/api/customer-loyalty","href":"/loyalty-storefront-api/customer-enrollment-\u0026-profile/get-customer-loyalty-information"},{"title":"Enable loyalty program for customer","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/enable-loyalty-program","href":"/loyalty-storefront-api/customer-enrollment-\u0026-profile/enable-loyalty-program-for-customer"},{"title":"Enroll customer in loyalty program","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/enroll-customer","href":"/loyalty-storefront-api/customer-enrollment-\u0026-profile/enroll-customer-in-loyalty-program"},{"title":"Get logged-in customer ID","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json get /loyalty/cp/api/logged-in-customer","href":"/loyalty-storefront-api/customer-enrollment-\u0026-profile/get-logged-in-customer-id"},{"title":"Sync customer metafield data","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/update-customer","href":"/loyalty-storefront-api/customer-enrollment-\u0026-profile/sync-customer-metafield-data"},{"title":"Update customer birth date","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/update-customer-birth-date","href":"/loyalty-storefront-api/customer-enrollment-\u0026-profile/update-customer-birth-date"},{"title":"Update customer loyalty status","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/update-customer-status","href":"/loyalty-storefront-api/customer-enrollment-\u0026-profile/update-customer-loyalty-status"}]},{"group":"Redemptions \u0026 Discount Codes","pages":[{"title":"Redeem customer loyalty points","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/redeem-points","href":"/loyalty-storefront-api/redemptions-\u0026-discount-codes/redeem-customer-loyalty-points"},{"title":"Return an unused reward for its points","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/return-reward/{rewardId}","href":"/loyalty-storefront-api/redemptions-\u0026-discount-codes/return-an-unused-reward-for-its-points"}]},{"group":"Product Catalog","pages":[{"title":"Proxy a Shopify Storefront GraphQL request from the customer portal","deprecated":null,"version":null,"openapi":"/loyalty/storefront-api-swagger.json post /loyalty/cp/api/storefront-graphql","href":"/loyalty-storefront-api/product-catalog/proxy-a-shopify-storefront-graphql-request-from-the-customer-portal"}]}]}]},{"tab":"Memberships","icon":"id-card","pages":[{"title":"Memberships","href":"/memberships/introduction"}]},{"tab":"Bundles","icon":"boxes-stacked","pages":[{"title":"Bundles","href":"/bundles/introduction"}]}]},"basePath":"","title":"Get a customer's referral history - Appstle","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CYZot51e.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}