Generate an API key from your dashboard and authorize your Referly API requests with a Bearer token.
The API is a premium feature that’s only available to users who have an active
Business Plan. See Pricing Page
To use this API, you need to have created your Affiliate Program and entered all necessary details.All API endpoints are authenticated using Bearer tokens, this requires you to have completed creating your Affiliate Program. Here’s how you create an Auth Token:Step 1. Click on API Keys on your dashboard sidebar:Step 2. Click on Generate New API Key +:Step 3. Click the copy icon to copy your Auth Token:Step 4. Add your Auth Token to your API requests:
{ "Authorization": "Bearer <YOUR_TOKEN>"}
Your API key grants full access to your program. Keep it on your server and never expose it in
client-side code.
Last modified on July 23, 2026
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Referly","colors":{"primary":"#7C4EDE","light":"#7C4EDE","dark":"#7C4EDE"},"logo":{"light":"https://mintcdn.com/pushlapgrowth/bqDBVim08kwiGgaD/logo/light.svg?fit=max\u0026auto=format\u0026n=bqDBVim08kwiGgaD\u0026q=85\u0026s=bb1ec9270844603f0405cd24a1b4cd8c","dark":"https://mintcdn.com/pushlapgrowth/bqDBVim08kwiGgaD/logo/dark.svg?fit=max\u0026auto=format\u0026n=bqDBVim08kwiGgaD\u0026q=85\u0026s=94c8febd62b7ec121319b135eea00a7d"},"favicon":"https://mintcdn.com/pushlapgrowth/bqDBVim08kwiGgaD/favicon.svg?fit=max\u0026auto=format\u0026n=bqDBVim08kwiGgaD\u0026q=85\u0026s=41d452a769189533fcdba17d810d8726","appearance":{"default":"light"},"navbar":{"links":[{"href":"mailto:support@referly.so","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://referly.so/dashboard"}},"footer":{"socials":{"x":"https://x.com/referlyso","linkedin":"https://www.linkedin.com/company/104551551","instagram":"https://www.instagram.com/referly.so"}},"seo":{"metatags":{"og:site_name":"Referly","og:type":"website","twitter:card":"summary_large_image","twitter:site":"@referlyso"},"organization":{"name":"Referly","legalName":"Referly","url":"https://www.referly.so","logo":"https://www.referly.so/logo/light.svg","sameAs":["https://x.com/referlyso","https://www.linkedin.com/company/104551551","https://www.instagram.com/referly.so"]},"indexing":"all"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"interaction":{"drilldown":false},"metadata":{"timestamp":true},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pushlapgrowth","hasAudioNarration":false,"actualSubdomain":"pushlapgrowth","customDomains":["www.referly.so"],"gitSource":{"type":"github","owner":"abdulsamad234","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a95990b153a7f51cc840b17","collectionId":"a5ccdac7-c498-4f1e-b8b0-8b73aebc0b32","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a95990b153a7f51cc840b17"},"entitlements":{},"buildId":"6a95990b153a7f51cc840b17","clientVersion":"0.0.3894","searchFilterCounts":[{"language":"default","tag":"Help Center","count":214},{"language":"default","tag":"Developer Documentation","count":43},{"language":"default","tag":"Integrations","count":43},{"language":"default","tag":"Managing your program","count":39},{"language":"default","tag":"Getting started","count":32},{"language":"default","tag":"Engaging affiliates","count":31},{"language":"default","tag":"API Reference","count":29},{"language":"default","tag":"Program settings","count":26},{"language":"default","tag":"For affiliates","count":22},{"language":"default","tag":"Gamification","count":17}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"editor-private-page-search","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":"teamspace","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"#navbar .nav-tabs-item{text-shadow:none!important}#navbar .nav-tabs-item::after{content:\"\";position:absolute;left:0;right:0;bottom:0;height:2px;border-radius:9999px;background-color:transparent;transition:background-color 150ms ease}#navbar .nav-tabs-item:hover::after{background-color:rgb(var(--primary)/.3)}#navbar .nav-tabs-item[data-active=true]{color:rgb(var(--primary))}#navbar .nav-tabs-item[data-active=true]::after{background-color:rgb(var(--primary))}.dark #navbar .nav-tabs-item[data-active=true]{color:rgb(var(--primary-light))}.dark #navbar .nav-tabs-item[data-active=true]::after{background-color:rgb(var(--primary-light))}.dark #navbar .nav-tabs-item:hover::after{background-color:rgb(var(--primary-light)/.3)}#topbar-cta-button>a{border-radius:.75rem;padding:.5rem .75rem;font-weight:500}#content-area{max-width:45rem}#content-area img,#content-area video{border-radius:.75rem}"}],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Authentication","description":"Generate an API key from your dashboard and authorize your Referly API requests with a Bearer token.","keywords":["API key","authentication","bearer token","Referly API"],"href":"/api-reference/authentication"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Generate an API key from your dashboard and authorize your Referly API requests with a Bearer token.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Note,OptimizedImage,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[`The API is a premium feature that’s only available to users who have an active\nBusiness Plan. `,_jsx(_components.a,{href:`https://referly.so/pricing`,children:`See Pricing Page`})]})}),`\n`,_jsx(_components.p,{children:`To use this API, you need to have created your Affiliate Program and entered all necessary details.`}),`\n`,_jsx(_components.p,{children:`All API endpoints are authenticated using Bearer tokens, this requires you to have completed creating your Affiliate Program. Here’s how you create an Auth Token:`}),`\n`,_jsxs(_components.p,{children:[`Step 1. Click on `,_jsx(_components.code,{children:`API Keys`}),` on your dashboard sidebar:`]}),`\n`,_jsx(OptimizedImage,{className:`mint-block`,src:`https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-1.png?fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=87bb8c02e7739767552afc488d263e59`,alt:`The API Keys item in the Referly dashboard sidebar`,\"data-og-width\":`534`,width:`534`,\"data-og-height\":`294`,height:`294`,\"data-path\":`images/step-1.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-1.png?w=280\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=459d18e52fe035c4c63b2b6cde9b4d7a 280w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-1.png?w=560\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=bda77463b2e665646ea55c174ef3b85a 560w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-1.png?w=840\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=5933901b7b2ac31c1507d45def07d4b6 840w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-1.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=0bfe18f4a4c38ab4ea33429b3ccc4b8e 1100w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-1.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=3ad524bd72f91b039a9b9c4aced89236 1650w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-1.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=a7bd7e34da70b86d780cb3ea2d6ca74a 2500w`}),`\n`,_jsxs(_components.p,{children:[`Step 2. Click on `,_jsx(_components.code,{children:`Generate New API Key +`}),`:`]}),`\n`,_jsx(OptimizedImage,{className:`mint-block`,src:`https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-2.png?fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=77501b00c285ce8d02c07ea70e352a42`,alt:`The Generate New API Key button in the Referly dashboard`,\"data-og-width\":`2372`,width:`2372`,\"data-og-height\":`384`,height:`384`,\"data-path\":`images/step-2.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-2.png?w=280\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=4cabf5adbd8717aa9f3df0aa940d53a3 280w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-2.png?w=560\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=54c36ad9c1f526f10dc3ea0ab51dc03d 560w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-2.png?w=840\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=0196e6ac8c565d51202707e5326138f1 840w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-2.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=46b08eecd352182e4ba36d2fc4fb091e 1100w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-2.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=fd0b5adfdfddaccc5bd8a5d0549b9e19 1650w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-2.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=3542e6a91eaba70435379af39d2c9c7f 2500w`}),`\n`,_jsx(_components.p,{children:`Step 3. Click the copy icon to copy your Auth Token:`}),`\n`,_jsx(OptimizedImage,{className:`mint-block`,src:`https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-3.png?fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=829e41e4f32f9fcb2b6718b6384c92e9`,alt:`Copying the generated auth token in the Referly dashboard`,\"data-og-width\":`1132`,width:`1132`,\"data-og-height\":`218`,height:`218`,\"data-path\":`images/step-3.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-3.png?w=280\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=0793c27a15ec4104eb498ca7956967c1 280w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-3.png?w=560\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=a010568aab1935dfe4a65d54e94e413b 560w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-3.png?w=840\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=33b262ddc54e05323b189eae73d86843 840w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-3.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=1ddca03a7fe0d2a4f419e16f4816cc0a 1100w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-3.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=e79927ff2562af4a5420b3bcd29e8535 1650w, https://mintcdn.com/pushlapgrowth/Kgf273m3Sfv2f_w5/images/step-3.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Kgf273m3Sfv2f_w5\u0026q=85\u0026s=a4c7942972e20c66a2607652715fe7b4 2500w`}),`\n`,_jsx(_components.p,{children:`Step 4. Add your Auth Token to your API requests:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"Authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bearer \u003cYOUR_TOKEN>\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Your API key grants full access to your program. Keep it on your server and never expose it in\nclient-side code.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Authentication","description":"Generate an API key from your dashboard and authorize your Referly API requests with a Bearer token.","keywords":["API key","authentication","bearer token","Referly API"],"href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-block {\n display: block\n}","subdomain":"pushlapgrowth","siteName":"Referly","title":"Authentication - Referly","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-23T00:27:40.774Z","gitLastModified":"2026-07-23T00:27:15.000Z","originalFileLocation":"api-reference/authentication.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Generate an API key from your dashboard and authorize your Referly API requests with a Bearer token.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Referly\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_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=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Referly\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generate an API key from your dashboard and authorize your Referly API requests with a Bearer token.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Referly\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.referly.so/docs/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pushlapgrowth.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Authentication\u0026amp;description=Generate+an+API+key+from+your+dashboard+and+authorize+your+Referly+API+requests+with+a+Bearer+token.\u0026amp;theme=3a8337a54097c6ff2918ad64\u0026amp;signature=5f5baf11995b89d067d3a28591fbc13f1cc7b23926a1cb37a7fc0df96498b1db\">\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=\"Authentication - Referly\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generate an API key from your dashboard and authorize your Referly API requests with a Bearer token.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pushlapgrowth.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Authentication\u0026amp;description=Generate+an+API+key+from+your+dashboard+and+authorize+your+Referly+API+requests+with+a+Bearer+token.\u0026amp;theme=3a8337a54097c6ff2918ad64\u0026amp;signature=5f5baf11995b89d067d3a28591fbc13f1cc7b23926a1cb37a7fc0df96498b1db\">\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=\"/docs/mintlify-assets/_mintlify/favicons/pushlapgrowth/-lMR5Z0Tt4D7HRCn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Referly\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7C4EDE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.referly.so/docs/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.referly.so/#organization\",\"name\":\"Referly\",\"legalName\":\"Referly\",\"url\":\"https://www.referly.so\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.referly.so/logo/light.svg\"},\"sameAs\":[\"https://x.com/referlyso\",\"https://www.linkedin.com/company/104551551\",\"https://www.instagram.com/referly.so\"]},{\"@type\":\"WebSite\",\"@id\":\"https://www.referly.so/docs#website\",\"name\":\"Referly\",\"url\":\"https://www.referly.so/docs\",\"publisher\":{\"@id\":\"https://www.referly.so/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.referly.so/docs/api-reference/authentication#webpage\",\"url\":\"https://www.referly.so/docs/api-reference/authentication\",\"name\":\"Authentication\",\"description\":\"Generate an API key from your dashboard and authorize your Referly API requests with a Bearer token.\",\"dateModified\":\"2026-07-23T00:27:15.000Z\",\"isPartOf\":{\"@id\":\"https://www.referly.so/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.referly.so/docs/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.referly.so/docs/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://www.referly.so/docs/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://www.referly.so/docs/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.referly.so/docs/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Generate an API key from your dashboard and authorize your Referly API requests with a Bearer token.\",\"url\":\"https://www.referly.so/docs/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://www.referly.so/docs/api-reference/authentication#webpage\"},\"dateModified\":\"2026-07-23T00:27:15.000Z\",\"keywords\":\"API key, authentication, bearer token, Referly API\",\"publisher\":{\"@id\":\"https://www.referly.so/#organization\"},\"isPartOf\":{\"@id\":\"https://www.referly.so/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Referly\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Referly","nav":{"global":null,"tabs":[{"tab":"Help Center","icon":"life-ring","pages":[{"title":"Help Center","href":"/help-center"}]},{"tab":"Developer Documentation","icon":"book","pages":[{"title":"Developer Documentation","href":"/developer-documentation"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"API Documentation","icon":"book","pages":[{"title":"Referly API Reference","description":"The Referly REST API lets you read and write affiliates, referrals, sales, links, coupons, and promotional codes, and attribute commissions from your own systems.","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Affiliates and referral links","description":"How affiliates and referral links relate in the Referly API: the affiliateLinks array, the deprecated link field, slug rules, tracking URLs, and the endpoints for creating and managing links.","href":"/api-reference/affiliate-links"},{"title":"Coupons and promotional codes","href":"/api-reference/coupons-and-promotional-codes"},{"title":"Zapier OAuth Integration","href":"/api-reference/zapier/oauth"}]},{"group":"Affiliate Endpoints","icon":"users","pages":[{"title":"Get Affiliate(s)","openapi":"GET /affiliates","href":"/api-reference/affiliates/get"},{"title":"Create an Affiliate","openapi":"POST /affiliates","href":"/api-reference/affiliates/create"},{"title":"Delete Affiliates","openapi":"DELETE /affiliates","href":"/api-reference/affiliates/delete"},{"title":"Update Affiliate","openapi":"PUT /affiliates","href":"/api-reference/affiliates/update"}]},{"group":"Referral Endpoints","icon":"share-nodes","pages":[{"title":"Get Referral(s)","openapi":"GET /referrals","href":"/api-reference/referrals/get"},{"title":"Create a Referral","openapi":"POST /referrals","href":"/api-reference/referrals/create"},{"title":"Delete Referrals","openapi":"DELETE /referrals","href":"/api-reference/referrals/delete"},{"title":"Update Referral","openapi":"PUT /referrals","href":"/api-reference/referrals/update"}]},{"group":"Sale Endpoints","icon":"cart-shopping","pages":[{"title":"Get Sale(s)","openapi":"GET /sales","href":"/api-reference/sales/get"},{"title":"Create a Sale","openapi":"POST /sales","href":"/api-reference/sales/create"},{"title":"Delete Sale","openapi":"DELETE /sales","href":"/api-reference/sales/delete"},{"title":"Update Sale","openapi":"PUT /sales","href":"/api-reference/sales/update"}]},{"group":"Affiliate Link Endpoints","icon":"link","pages":[{"title":"Get Affiliate Link(s)","openapi":"GET /links","href":"/api-reference/links/get"},{"title":"Create an Affiliate Link","openapi":"POST /links","href":"/api-reference/links/create"},{"title":"Delete Affiliate Link","openapi":"DELETE /links","href":"/api-reference/links/delete"},{"title":"Update Affiliate Link","openapi":"PUT /links","href":"/api-reference/links/update"}]},{"group":"Coupon Endpoints","icon":"ticket","pages":[{"title":"Get Coupons","openapi":"GET /coupons","href":"/api-reference/coupons/get"},{"title":"Create a Coupon","openapi":"POST /coupons","href":"/api-reference/coupons/create"},{"title":"Delete a Coupon","openapi":"DELETE /coupons","href":"/api-reference/coupons/delete"},{"title":"Update a Coupon","openapi":"PUT /coupons","href":"/api-reference/coupons/update"}]},{"group":"Promotional Code Endpoints","icon":"tag","pages":[{"title":"Get Promotional Codes","openapi":"GET /promotional-codes","href":"/api-reference/promotional-codes/get"},{"title":"Create a Promotional Code","openapi":"POST /promotional-codes","href":"/api-reference/promotional-codes/create"},{"title":"Delete a Promotional Code","openapi":"DELETE /promotional-codes","href":"/api-reference/promotional-codes/delete"},{"title":"Update a Promotional Code","openapi":"PUT /promotional-codes","href":"/api-reference/promotional-codes/update"}]}]}]},"title":"Authentication - Referly","buildId":"dpl_9hmKkjkf3GomzUYvEzceDf6ERcsX","deploymentId":"dpl_9hmKkjkf3GomzUYvEzceDf6ERcsX","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-Cfk1lvMz.js","PlusIcon-ShPOYkx0.js","lightbox-handle-r17bVUz3.js"]}