For the API endpoints marked as authenticated using Bearer tokens, make sure to pass the Authorization header with your bearer token.Your bearer token will be provided by the Playback support team during the onboarding process.
Partners should continually be fetching offers from the API to make sure the offers shown to users are valid and up to date. When an offer is paused or reaches a budget cap, it’s removed from the API response.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Playback Direct","colors":{"primary":"#F59E0B","light":"#F59E0B"},"logo":{"light":"https://mintcdn.com/playbackrewards/uLpwcfZdgWkvLy8A/images/HeaderLogo.png?fit=max\u0026auto=format\u0026n=uLpwcfZdgWkvLy8A\u0026q=85\u0026s=7e1fae5015ca49cc2bdab4fc3a213829","dark":"https://mintcdn.com/playbackrewards/uLpwcfZdgWkvLy8A/images/HeaderLogo.png?fit=max\u0026auto=format\u0026n=uLpwcfZdgWkvLy8A\u0026q=85\u0026s=7e1fae5015ca49cc2bdab4fc3a213829"},"favicon":{"light":"https://mintcdn.com/playbackrewards/uLpwcfZdgWkvLy8A/images/Favicon.png?fit=max\u0026auto=format\u0026n=uLpwcfZdgWkvLy8A\u0026q=85\u0026s=e2cae09fc46fb869fdb6b5630eb13aee","dark":"https://mintcdn.com/playbackrewards/uLpwcfZdgWkvLy8A/images/Favicon.png?fit=max\u0026auto=format\u0026n=uLpwcfZdgWkvLy8A\u0026q=85\u0026s=e2cae09fc46fb869fdb6b5630eb13aee"},"api":{"examples":{"defaults":"all"}},"navbar":{"links":[]},"footer":{},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"playbackrewards","hasAudioNarration":false,"actualSubdomain":"playbackrewards","customDomains":["docs.playbackrewards.com"],"gitSource":{"type":"github","owner":"hwdgroup","repo":"offerwall-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a9ad36e4586c4b6f49584f3","collectionId":"4beea547-62b6-48f4-8221-b00f3b562735","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a9ad36e4586c4b6f49584f3"},"entitlements":{},"buildId":"6a9ad36e4586c4b6f49584f3","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Guides","count":10},{"language":"default","tag":"API integration","count":5},{"language":"default","tag":"Iframe integration","count":4},{"language":"default","tag":"API Reference","count":3},{"language":"default","tag":"Partners","count":2},{"language":"default","tag":"Tracking","count":1}]},"assistantConfig":{},"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":"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":"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":"editor-version-history-v2","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":"billing-page-v2","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":"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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":":root{--mintlify-slot-header-height:7rem}"}],"page":{"pagePath":"playbackapi/api","slug":"/playbackapi/api","pageMetadata":{"title":"API","description":null,"href":"/playbackapi/api"},"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={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`For the API endpoints marked as authenticated using Bearer tokens, make sure to pass the `,_jsx(_components.code,{children:`Authorization`}),` header with your bearer token.`]}),`\n`,_jsx(_components.p,{children:`Your bearer token will be provided by the Playback support team during the onboarding process.`}),`\n`,_jsx(Heading,{level:`3`,id:`example`,children:`Example`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.playbackdirect.com/v1/partners/offers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_TOKEN_HERE\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`details`,children:`Details`}),`\n`,_jsx(_components.p,{children:`Partners should continually be fetching offers from the API to make sure the offers shown to users are valid and up to date. When an offer is paused or reaches a budget cap, it’s removed from the API response.`})]})}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":"API","description":null,"href":"/playbackapi/api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication","slug":"authentication","depth":2,"children":[{"title":"Example","slug":"example","depth":3,"children":[]}]},{"title":"Details","slug":"details","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"playbackrewards","siteName":"Playback Direct","title":"API - Playback Direct","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-04T14:19:44.218Z","originalFileLocation":"playbackapi/api.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=\"application-name\" content=\"Playback Direct\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/playbackrewards/EmjbGKYPz6BLIQe7/_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/playbackrewards/EmjbGKYPz6BLIQe7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/playbackrewards/EmjbGKYPz6BLIQe7/_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/playbackrewards/EmjbGKYPz6BLIQe7/_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/playbackrewards/EmjbGKYPz6BLIQe7/_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/playbackrewards/EmjbGKYPz6BLIQe7/_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/playbackrewards/EmjbGKYPz6BLIQe7/_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/playbackrewards/EmjbGKYPz6BLIQe7/_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/playbackrewards/EmjbGKYPz6BLIQe7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API - Playback Direct\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Playback Direct\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.playbackrewards.com/playbackapi/api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://playbackrewards.mintlify.app/_mintlify/api/og/v2?division=API+integration\u0026amp;title=API\u0026amp;theme=285f1b0ad62365fff6fd1364\u0026amp;signature=cec2f133fd165cf3bdb4e90de0d01454b96f792b19ba4bfdb145c9de5e3d705e\">\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=\"API - Playback Direct\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://playbackrewards.mintlify.app/_mintlify/api/og/v2?division=API+integration\u0026amp;title=API\u0026amp;theme=285f1b0ad62365fff6fd1364\u0026amp;signature=cec2f133fd165cf3bdb4e90de0d01454b96f792b19ba4bfdb145c9de5e3d705e\">\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/playbackrewards/EmjbGKYPz6BLIQe7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Playback Direct\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F59E0B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.playbackrewards.com/playbackapi/api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/playbackapi/api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.playbackrewards.com/#organization\",\"name\":\"Playback Direct\",\"url\":\"https://docs.playbackrewards.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/playbackrewards/uLpwcfZdgWkvLy8A/images/HeaderLogo.png?fit=max\u0026auto=format\u0026n=uLpwcfZdgWkvLy8A\u0026q=85\u0026s=7e1fae5015ca49cc2bdab4fc3a213829\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.playbackrewards.com#website\",\"name\":\"Playback Direct\",\"url\":\"https://docs.playbackrewards.com\",\"publisher\":{\"@id\":\"https://docs.playbackrewards.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.playbackrewards.com/playbackapi/api#webpage\",\"url\":\"https://docs.playbackrewards.com/playbackapi/api\",\"name\":\"API\",\"dateModified\":\"2026-09-04T14:19:44.218Z\",\"isPartOf\":{\"@id\":\"https://docs.playbackrewards.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.playbackrewards.com/playbackapi/api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.playbackrewards.com/playbackapi/api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API integration\",\"item\":\"https://docs.playbackrewards.com/playbackapi/setup\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API\",\"item\":\"https://docs.playbackrewards.com/playbackapi/api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.playbackrewards.com/playbackapi/api#article\",\"headline\":\"API\",\"name\":\"API\",\"url\":\"https://docs.playbackrewards.com/playbackapi/api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.playbackrewards.com/playbackapi/api#webpage\"},\"dateModified\":\"2026-09-04T14:19:44.218Z\",\"publisher\":{\"@id\":\"https://docs.playbackrewards.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.playbackrewards.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Playback Direct\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Playback Direct","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Guides","pages":[{"title":"Playback Direct","href":""},{"group":"Iframe integration","pages":[{"title":"Intro","href":"/playbackdirect/getstarted/intro"},{"title":"Overview","href":"/playbackdirect/getstarted/offersoverview"},{"title":"Implementation","href":"/playbackdirect/setup/implementingplayback"},{"title":"Postbacks","href":"/playbackdirect/setup/servertoserverpayouts"}]},{"group":"API integration","pages":[{"title":"Getting started","description":null,"href":"/playbackapi/setup"},{"title":"API","href":"/playbackapi/api"},{"title":"Tracking","description":null,"href":"/playbackapi/tracking"},{"title":"Postbacks","href":"/playbackapi/postbacks"},{"title":"Reporting","href":"/playbackapi/postbacks-2"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/partners/get-active-partner-offers"}]}]},"title":"API - Playback Direct","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":[],"chunks":[]}