{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FirstPromoter Docs","colors":{"primary":"#2497F3","light":"#42A5F5","dark":"#1A1C25"},"logo":{"light":"https://mintcdn.com/firstpromoter/Qml53iAwCwPGiKRZ/logo/light.svg?fit=max\u0026auto=format\u0026n=Qml53iAwCwPGiKRZ\u0026q=85\u0026s=17d35344b27497f795682da8932295c9","dark":"https://mintcdn.com/firstpromoter/Qml53iAwCwPGiKRZ/logo/dark.svg?fit=max\u0026auto=format\u0026n=Qml53iAwCwPGiKRZ\u0026q=85\u0026s=ef23e747176d9a87b5ddf122595793f8"},"favicon":"https://mintcdn.com/firstpromoter/rNk-Jdvp2vdjAvd9/favicon.png?fit=max\u0026auto=format\u0026n=rNk-Jdvp2vdjAvd9\u0026q=85\u0026s=7faf17e323609b0fef661b9a9fe49ebc","navbar":{"links":[{"href":"mailto:support@firstpromoter.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://login.firstpromoter.com/"}},"footer":{"socials":{"x":"https://x.com/firstpromoter","linkedin":"https://www.linkedin.com/company/first-promoter"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firstpromoter","hasAudioNarration":false,"actualSubdomain":"firstpromoter","customDomains":["docs.firstpromoter.com"],"gitSource":{"type":"github","owner":"firstpromoter","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aedb2dbad97e8452b1fe618","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Documentation","count":213},{"language":"default","tag":"API Reference","count":81},{"language":"default","tag":"Integration Options","count":41},{"language":"default","tag":"Promoters","count":25},{"language":"default","tag":"Platform","count":23},{"language":"default","tag":"Custom","count":9},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Reports","count":8},{"language":"default","tag":"Payouts","count":7},{"language":"default","tag":"Commissions","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference-v1/payouts-api/list","slug":"/api-reference-v1/payouts-api/list","pageMetadata":{"title":"List payouts","openapi":"openapi-payouts GET /list","description":"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. \u003cTip>**HTTP Request** \u003cbr/>\u003cbr/> `GET https://firstpromoter.com/api/v1/payouts/list`\u003c/Tip>","href":"/api-reference-v1/payouts-api/list"},"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 strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n }, {Tip} = _components;\n if (!Tip) _missingMdxReference(\"Tip\", true);\n return _jsxs(_components.p, {\n children: [\"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. \", _jsxs(Tip, {\n children: [_jsx(_components.strong, {\n children: \"HTTP Request\"\n }), \" \", _jsx(\"br\", {}), _jsx(\"br\", {}), \" \", _jsx(_components.code, {\n children: \"GET https://firstpromoter.com/api/v1/payouts/list\"\n })]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\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":"List payouts","openapi":"openapi-payouts GET /list","description":"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. \u003cTip>**HTTP Request** \u003cbr/>\u003cbr/> `GET https://firstpromoter.com/api/v1/payouts/list`\u003c/Tip>","href":"/api-reference-v1/payouts-api/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstpromoter/8ad42af542d542c7/downloadables/fpr-prox.js"],"openApiReferenceData":{"operation":{"description":"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. \u003cTip>**HTTP Request** \u003cbr/>\u003cbr/> `GET https://firstpromoter.com/api/v1/payouts/list`\u003c/Tip>","parameters":["cf79fc39-93ab-4473-af50-3fbc3f1340b3","83bdfbbb-2594-4df6-972c-23c63199b14f","18dcdab0-6da2-46bf-be00-42aa3fe845f2"],"responses":{"200":"2de05012-e594-43d5-b537-1b7a690103d6"},"method":"get","type":"path","servers":["ad4ead3b-8a2d-4d2b-94af-0e2d2a4e4987"],"security":["40b02a76-f7c7-49ef-b3e3-7ef1a918ecde"],"path":"/list","baseUrlOptions":["https://firstpromoter.com/api/v1/payouts"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cf79fc39-93ab-4473-af50-3fbc3f1340b3":{"name":"promoter_id","in":"query","description":"List all payouts assigned to a promoter","schema":{"type":"string","description":"List all payouts assigned to a promoter","uniqueKey":"","typeLabel":"string"}},"83bdfbbb-2594-4df6-972c-23c63199b14f":{"name":"campaign_id","in":"query","description":"List all payouts of a campaign","schema":{"type":"string","description":"List all payouts of a campaign","uniqueKey":"","typeLabel":"string"}},"18dcdab0-6da2-46bf-be00-42aa3fe845f2":{"name":"status","in":"query","description":"Filter payouts by status.","schema":{"type":"string","enum":["pending","processing","completed"],"description":"Filter payouts by status.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"2de05012-e594-43d5-b537-1b7a690103d6":{"description":"Success response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":2709255,"uniqueKey":"items.[INDEX].id","typeLabel":"integer"},"status":{"type":"string","example":"completed","uniqueKey":"items.[INDEX].status","typeLabel":"string"},"amount":{"type":"integer","example":12,"uniqueKey":"items.[INDEX].amount","typeLabel":"integer"},"date_paid":{"type":"string","format":"date-time","example":"2024-09-04T15:23:20.630Z","uniqueKey":"items.[INDEX].date_paid","typeLabel":"string\u003cdate-time>"},"due_date":{"oneOf":[{"type":"string","example":null,"uniqueKey":"items.[INDEX].due_date.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].due_date","typeLabel":"string | null"},"unit":{"type":"string","example":"points","uniqueKey":"items.[INDEX].unit","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","example":"2024-09-04T15:23:16.392Z","uniqueKey":"items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"has_issues":{"type":"boolean","example":false,"uniqueKey":"items.[INDEX].has_issues","typeLabel":"boolean"},"reward":{"type":"object","properties":{"id":{"type":"integer","example":140362,"uniqueKey":"items.[INDEX].reward.id","typeLabel":"integer"},"amount":{"type":"integer","example":0,"uniqueKey":"items.[INDEX].reward.amount","typeLabel":"integer"},"type":{"type":"string","example":"per_promotion","uniqueKey":"items.[INDEX].reward.type","typeLabel":"string"},"unit":{"type":"string","example":"points","uniqueKey":"items.[INDEX].reward.unit","typeLabel":"string"},"name":{"type":"string","example":"Points","uniqueKey":"items.[INDEX].reward.name","typeLabel":"string"},"per_of_sale":{"type":"integer","example":0,"uniqueKey":"items.[INDEX].reward.per_of_sale","typeLabel":"integer"},"default_promo_code":{"oneOf":[{"type":"string","example":null,"uniqueKey":"items.[INDEX].reward.default_promo_code.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"items.[INDEX].reward.default_promo_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].reward.default_promo_code","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].reward","typeLabel":"object"},"promoter":{"type":"object","properties":{"id":{"type":"integer","example":8736661,"uniqueKey":"items.[INDEX].promoter.id","typeLabel":"integer"},"status":{"type":"string","example":"active","uniqueKey":"items.[INDEX].promoter.status","typeLabel":"string"},"cust_id":{"oneOf":[{"type":"string","example":null,"uniqueKey":"items.[INDEX].promoter.cust_id.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"items.[INDEX].promoter.cust_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promoter.cust_id","typeLabel":"string | null"},"email":{"type":"string","example":"test+demo2@mail.com","uniqueKey":"items.[INDEX].promoter.email","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","example":"2024-08-21T17:08:40.500Z","uniqueKey":"items.[INDEX].promoter.created_at","typeLabel":"string\u003cdate-time>"},"temp_password":{"oneOf":[{"type":"string","example":"api@test1A0","uniqueKey":"items.[INDEX].promoter.temp_password.oneOf.0","typeLabel":"string"},{"type":"null","example":"api@test1A0","uniqueKey":"items.[INDEX].promoter.temp_password.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promoter.temp_password","typeLabel":"string | null"},"default_promotion_id":{"type":"integer","example":10008220,"uniqueKey":"items.[INDEX].promoter.default_promotion_id","typeLabel":"integer"},"pref":{"type":"string","example":"2ejxve3","uniqueKey":"items.[INDEX].promoter.pref","typeLabel":"string"},"default_ref_id":{"type":"string","example":"i4fth","uniqueKey":"items.[INDEX].promoter.default_ref_id","typeLabel":"string"},"note":{"oneOf":[{"type":"string","example":null,"uniqueKey":"items.[INDEX].promoter.note.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"items.[INDEX].promoter.note.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promoter.note","typeLabel":"string | null"},"w8_form_url":{"oneOf":[{"type":"string","example":null,"uniqueKey":"items.[INDEX].promoter.w8_form_url.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"items.[INDEX].promoter.w8_form_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promoter.w8_form_url","typeLabel":"string | null"},"w9_form_url":{"oneOf":[{"type":"string","example":null,"uniqueKey":"items.[INDEX].promoter.w9_form_url.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"items.[INDEX].promoter.w9_form_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promoter.w9_form_url","typeLabel":"string | null"},"parent_promoter_id":{"oneOf":[{"type":"integer","example":null,"uniqueKey":"items.[INDEX].promoter.parent_promoter_id.oneOf.0","typeLabel":"integer"},{"type":"null","example":null,"uniqueKey":"items.[INDEX].promoter.parent_promoter_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promoter.parent_promoter_id","typeLabel":"integer | null"},"earnings_balance":{"type":"object","properties":{"cash":{"type":"integer","example":28800,"uniqueKey":"items.[INDEX].promoter.earnings_balance.cash","typeLabel":"integer"},"points":{"type":"integer","example":24,"uniqueKey":"items.[INDEX].promoter.earnings_balance.points","typeLabel":"integer"},"free_months":{"type":"integer","example":3,"uniqueKey":"items.[INDEX].promoter.earnings_balance.free_months","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].promoter.earnings_balance","typeLabel":"object"},"current_balance":{"type":"object","properties":{"cash":{"type":"integer","example":28800,"uniqueKey":"items.[INDEX].promoter.current_balance.cash","typeLabel":"integer"},"points":{"type":"integer","example":-24,"uniqueKey":"items.[INDEX].promoter.current_balance.points","typeLabel":"integer"},"free_months":{"type":"integer","example":-3,"uniqueKey":"items.[INDEX].promoter.current_balance.free_months","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].promoter.current_balance","typeLabel":"object"},"paid_balance":{"type":"object","properties":{"points":{"type":"integer","example":48,"uniqueKey":"items.[INDEX].promoter.paid_balance.points","typeLabel":"integer"},"free_months":{"type":"integer","example":6,"uniqueKey":"items.[INDEX].promoter.paid_balance.free_months","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].promoter.paid_balance","typeLabel":"object"},"auth_token":{"type":"string","example":"pDdv3MnxH86p8s2WxJfMpSJfsYNV6SxX","uniqueKey":"items.[INDEX].promoter.auth_token","typeLabel":"string"}},"uniqueKey":"items.[INDEX].promoter","typeLabel":"object"},"campaign":{"type":"object","properties":{"id":{"type":"integer","example":26127,"uniqueKey":"items.[INDEX].campaign.id","typeLabel":"integer"},"name":{"type":"string","example":"Make Campaign","uniqueKey":"items.[INDEX].campaign.name","typeLabel":"string"},"landing_url":{"type":"string","example":"https://lastechworld.com","uniqueKey":"items.[INDEX].campaign.landing_url","typeLabel":"string"},"description":{"oneOf":[{"type":"string","example":null,"uniqueKey":"items.[INDEX].campaign.description.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"items.[INDEX].campaign.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].campaign.description","typeLabel":"string | null"},"private":{"type":"boolean","example":false,"uniqueKey":"items.[INDEX].campaign.private","typeLabel":"boolean"},"color":{"type":"string","example":"#26a69a","uniqueKey":"items.[INDEX].campaign.color","typeLabel":"string"},"default_webhook_url":{"type":"string","example":"https://hook.eu1.make.com/mw5u7tb7mnopiriozq8nb6wbeb82omrd","uniqueKey":"items.[INDEX].campaign.default_webhook_url","typeLabel":"string"},"auto_approve_rewards":{"type":"boolean","example":true,"uniqueKey":"items.[INDEX].campaign.auto_approve_rewards","typeLabel":"boolean"},"auto_approve_promoters":{"type":"boolean","example":true,"uniqueKey":"items.[INDEX].campaign.auto_approve_promoters","typeLabel":"boolean"}},"uniqueKey":"items.[INDEX].campaign","typeLabel":"object"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":2709255,"status":"completed","amount":12,"date_paid":"2024-09-04T15:23:20.630Z","due_date":null,"unit":"points","created_at":"2024-09-04T15:23:16.392Z","has_issues":false,"reward":{"id":140362,"amount":0,"type":"per_promotion","unit":"points","name":"Points","per_of_sale":0,"default_promo_code":null},"promoter":{"id":8736661,"status":"active","cust_id":null,"email":"test+demo2@mail.com","created_at":"2024-08-21T17:08:40.500Z","temp_password":"api@test1A0","default_promotion_id":10008220,"pref":"2ejxve3","default_ref_id":"i4fth","note":null,"w8_form_url":null,"w9_form_url":null,"parent_promoter_id":null,"earnings_balance":{"cash":28800,"points":24,"free_months":3},"current_balance":{"cash":28800,"points":-24,"free_months":-3},"paid_balance":{"points":48,"free_months":6},"auth_token":"pDdv3MnxH86p8s2WxJfMpSJfsYNV6SxX"},"campaign":{"id":26127,"name":"Make Campaign","landing_url":"https://lastechworld.com","description":null,"private":false,"color":"#26a69a","default_webhook_url":"https://hook.eu1.make.com/mw5u7tb7mnopiriozq8nb6wbeb82omrd","auto_approve_rewards":true,"auto_approve_promoters":true}}]}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"40b02a76-f7c7-49ef-b3e3-7ef1a918ecde":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"ad4ead3b-8a2d-4d2b-94af-0e2d2a4e4987":{"url":"https://firstpromoter.com/api/v1/payouts"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-KEY"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference-v1/payouts-api/openapi-payouts.json"},"subdomain":"firstpromoter","siteName":"FirstPromoter Docs","title":"List payouts - FirstPromoter Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference-v2/api-admin/payouts/get-all-payouts","matchLevel":2},"v1":{"href":"/api-reference-v1/payouts-api/list","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-08-07T12:33:18.643Z","originalFileLocation":"api-reference-v1/payouts-api/list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. HTTP Request GET https://firstpromoter.com/api/v1/payouts/list\">\u003cmeta data-mint-head name=\"application-name\" content=\"FirstPromoter Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_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/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List payouts - FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. HTTP Request GET https://firstpromoter.com/api/v1/payouts/list\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firstpromoter.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=List+payouts\u0026amp;description=With+this+endpoint%2C+you+can+list+all+payouts+for+a+promoter%2C+a+campaign%2C+or+the+entire+account+using+the+API.+%3CTip%3E**HTTP+Request**+%3Cbr%2F%3E%3Cbr%2F%3E+%60GET+https%3A%2F%2Ffirs\u0026amp;theme=fff9650e72028c28308bb6bc\u0026amp;signature=d049dcf2917ef6884bf6b42ea96e5446b6938b0db89622437a832684a7317515\">\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=\"List payouts - FirstPromoter Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. HTTP Request GET https://firstpromoter.com/api/v1/payouts/list\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstpromoter.mintlify.site/_mintlify/api/og/v2?division=Payouts\u0026amp;title=List+payouts\u0026amp;description=With+this+endpoint%2C+you+can+list+all+payouts+for+a+promoter%2C+a+campaign%2C+or+the+entire+account+using+the+API.+%3CTip%3E**HTTP+Request**+%3Cbr%2F%3E%3Cbr%2F%3E+%60GET+https%3A%2F%2Ffirs\u0026amp;theme=fff9650e72028c28308bb6bc\u0026amp;signature=d049dcf2917ef6884bf6b42ea96e5446b6938b0db89622437a832684a7317515\">\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/firstpromoter/NHAuOTz7uXRLkEOr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FirstPromoter Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2497F3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference-v1/payouts-api/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.firstpromoter.com/#organization\",\"name\":\"FirstPromoter Docs\",\"url\":\"https://docs.firstpromoter.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/firstpromoter/Qml53iAwCwPGiKRZ/logo/light.svg?fit=max\u0026auto=format\u0026n=Qml53iAwCwPGiKRZ\u0026q=85\u0026s=17d35344b27497f795682da8932295c9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.firstpromoter.com#website\",\"name\":\"FirstPromoter Docs\",\"url\":\"https://docs.firstpromoter.com\",\"publisher\":{\"@id\":\"https://docs.firstpromoter.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list#webpage\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list\",\"name\":\"List payouts\",\"description\":\"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. HTTP Request GET https://firstpromoter.com/api/v1/payouts/list\",\"dateModified\":\"2025-08-07T12:33:18.643Z\",\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"FirstPromoter Docs\",\"item\":\"https://docs.firstpromoter.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List payouts\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list#apireference\",\"headline\":\"List payouts\",\"name\":\"List payouts\",\"description\":\"With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. HTTP Request GET https://firstpromoter.com/api/v1/payouts/list\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/payouts-api/list#webpage\"},\"dateModified\":\"2025-08-07T12:33:18.643Z\",\"publisher\":{\"@id\":\"https://docs.firstpromoter.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FirstPromoter Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"FirstPromoter Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference-v1/payouts-api/list.md","siteName":"FirstPromoter Docs","nav":{"global":null,"versions":[{"version":"v2","pages":[{"title":"v2","href":"/api-reference-v2/api-admin/payouts/get-all-payouts"}]},{"version":"v1","anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference-v1/introduction"},{"title":"Authentication","href":"/api-reference-v1/authentication"}]},{"group":"Tracking","pages":[{"title":"Tracking leads and sign-ups","openapi":"openapi-tracking POST /signup","href":"/api-reference-v1/tracking-api/leads-and-signups"},{"title":"Tracking sales and commissions","openapi":"openapi-tracking POST /sale","href":"/api-reference-v1/tracking-api/sales"},{"title":"Tracking refunds and negative commissions","openapi":"openapi-tracking POST /refund","href":"/api-reference-v1/tracking-api/refund"},{"title":"Tracking cancellations","openapi":"openapi-tracking POST /cancellation","href":"/api-reference-v1/tracking-api/cancellation"}]},{"group":"Leads","pages":[{"title":"Modify existing lead/customer","openapi":"openapi-leads PUT /update","href":"/api-reference-v1/leads-api/update"},{"title":"List leads/customers","openapi":"openapi-leads GET /list","href":"/api-reference-v1/leads-api/list"},{"title":"Show leads and customers details","openapi":"openapi-leads GET /show","href":"/api-reference-v1/leads-api/show"},{"title":"Delete lead/customer","openapi":"openapi-leads DELETE /delete","href":"/api-reference-v1/leads-api/delete"}]},{"group":"Promoters","pages":[{"title":"Create a new promoter","openapi":"openapi-promoters POST /create","href":"/api-reference-v1/promoters-api/create"},{"title":"Modify existing promoter","openapi":"openapi-promoters PUT /update","href":"/api-reference-v1/promoters-api/update"},{"title":"List promoters","openapi":"openapi-promoters GET /list","href":"/api-reference-v1/promoters-api/list"},{"title":"Show promoter details and balance","openapi":"openapi-promoters GET /show","href":"/api-reference-v1/promoters-api/show-details"},{"title":"Move/switch a promoter from one campaign to another","openapi":"openapi-promoters POST /move_to_campaign","href":"/api-reference-v1/promoters-api/move-to-campaign"},{"title":"Add a promoter to a campaign","openapi":"openapi-promoters POST /add_to_campaign","href":"/api-reference-v1/promoters-api/add-to-campaign"},{"title":"Reset promoter's authentication token","openapi":"openapi-promoters PUT /refresh_token","href":"/api-reference-v1/promoters-api/refresh-token"},{"title":"Delete a promoter","openapi":"openapi-promoters DELETE /delete","href":"/api-reference-v1/promoters-api/delete"}]},{"group":"Rewards","pages":[{"title":"Create new reward","openapi":"openapi-rewards POST /create","href":"/api-reference-v1/rewards-api/create"},{"title":"List rewards and commissions","openapi":"openapi-rewards GET /list","href":"/api-reference-v1/rewards-api/list"},{"title":"Update a reward or commission","openapi":"openapi-rewards PUT /update","description":"You can use this endpoint to change the status of a reward or commission. You can identify the reward or commission by its id or the id of the event that generated the reward.\u003cNote>For Stripe, Recurly and Chargebee subscription the `event_id` value is the Invoice id, for Stripe one time charges is the charge id.\u003c/Note>\u003cTip>**HTTP Request** \u003cbr/>`PUT https://firstpromoter.com/api/v1/rewards/update`\u003c/Tip>","href":"/api-reference-v1/rewards-api/update"}]},{"group":"Payouts","pages":[{"title":"List payouts","openapi":"openapi-payouts GET /list","href":"/api-reference-v1/payouts-api/list"},{"title":"Create a new payout","openapi":"openapi-payouts POST /create","description":"This call allows you to create a payout for a specific promoter for the entire unpaid amount.","href":"/api-reference-v1/payouts-api/create"},{"title":"Change payouts status","openapi":"openapi-payouts PUT /update","href":"/api-reference-v1/payouts-api/update"}]},{"group":"Reports","pages":[{"title":"Overview reports","openapi":"openapi-reports GET /overview","href":"/api-reference-v1/reports-api/overview"},{"title":"Campaign reports","openapi":"openapi-reports GET /campaigns","href":"/api-reference-v1/reports-api/campaign"},{"title":"Promoter reports","openapi":"openapi-reports GET /promoters","href":"/api-reference-v1/reports-api/promoter"}]}]}]},{"anchor":"API Reference","icon":"webhook","href":"https://docs.firstpromoter.com/api-reference-v1/introduction"},{"anchor":"Help Center","icon":"square-question","href":"https://help.firstpromoter.com/en/"}]}]},"basePath":"","title":"List payouts - FirstPromoter Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}