{"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":""},"chroma":{"liveDeploymentHistoryId":"6ad5d6664613fdc88740d8e9","collectionId":"8fbb5c1e-fc55-4dd1-8162-6bca9be88e0f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad5d6664613fdc88740d8e9"},"entitlements":{},"buildId":"6ad5d6664613fdc88740d8e9","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Documentation","count":209},{"language":"default","tag":"API Reference","count":81},{"language":"default","tag":"Integration Options","count":39},{"language":"default","tag":"Promoters","count":25},{"language":"default","tag":"Platform","count":22},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Reports","count":8},{"language":"default","tag":"Custom","count":8},{"language":"default","tag":"Payouts","count":7},{"language":"default","tag":"Commissions","count":7}]},"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":"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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference-v1/leads-api/list","slug":"/api-reference-v1/leads-api/list","pageMetadata":{"title":"List leads/customers","openapi":"openapi-leads GET /list","description":"With this endpoint you can list all the leads and customers assigned to a promotion, promoter, campaign or entire account using the API. \u003cNote>Pagination details are held on response headers. Add `--include` option on `curl` request to see the pagination details format and links to next pages.\u003c/Note>\u003cTip>**HTTP Request** \u003cbr/> `GET https://firstpromoter.com/api/v1/leads/list`\u003c/Tip>","href":"/api-reference-v1/leads-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 }, {Note, Tip} = _components;\n if (!Note) _missingMdxReference(\"Note\", true);\n if (!Tip) _missingMdxReference(\"Tip\", true);\n return _jsxs(_components.p, {\n children: [\"With this endpoint you can list all the leads and customers assigned to a promotion, promoter, campaign or entire account using the API. \", _jsxs(Note, {\n children: [\"Pagination details are held on response headers. Add \", _jsx(_components.code, {\n children: \"--include\"\n }), \" option on \", _jsx(_components.code, {\n children: \"curl\"\n }), \" request to see the pagination details format and links to next pages.\"]\n }), _jsxs(Tip, {\n children: [_jsx(_components.strong, {\n children: \"HTTP Request\"\n }), \" \", _jsx(\"br\", {}), \" \", _jsx(_components.code, {\n children: \"GET https://firstpromoter.com/api/v1/leads/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 leads/customers","openapi":"openapi-leads GET /list","description":"With this endpoint you can list all the leads and customers assigned to a promotion, promoter, campaign or entire account using the API. \u003cNote>Pagination details are held on response headers. Add `--include` option on `curl` request to see the pagination details format and links to next pages.\u003c/Note>\u003cTip>**HTTP Request** \u003cbr/> `GET https://firstpromoter.com/api/v1/leads/list`\u003c/Tip>","href":"/api-reference-v1/leads-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 the leads and customers assigned to a promotion, promoter, campaign or entire account using the API. \u003cNote>Pagination details are held on response headers. Add `--include` option on `curl` request to see the pagination details format and links to next pages.\u003c/Note>\u003cTip>**HTTP Request** \u003cbr/> `GET https://firstpromoter.com/api/v1/leads/list`\u003c/Tip>","parameters":["3a740a73-18b9-4416-a335-241b090bc10c","948ab049-0aa8-4beb-b44e-c5f7787e34a8","338647f1-e19c-41ce-8e5a-6a317d8b3298","46b98690-e593-47c7-9695-92bd046949d0"],"responses":{"200":"6112d446-a666-4897-9f6a-08304754384a","401":"7b37c865-0725-41ff-b7b1-1eb1b4660236","422":"d57f5d77-5f59-43f8-8489-363d7b3aa639"},"method":"get","type":"path","servers":["5927f42c-1c12-4305-9732-67b507eeb01a"],"security":["6a9022dc-7824-4f97-a627-6379c189be69"],"path":"/list","baseUrlOptions":["https://firstpromoter.com/api/v1/leads"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3a740a73-18b9-4416-a335-241b090bc10c":{"name":"promotion_id","in":"query","description":"List all leads and customers assigned to this promotion id","schema":{"type":"string","description":"List all leads and customers assigned to this promotion id","uniqueKey":"","typeLabel":"string"}},"948ab049-0aa8-4beb-b44e-c5f7787e34a8":{"name":"ref_id","in":"query","description":"List all leads and customers assigned to a promotion - find promotion by `ref_id`","schema":{"type":"string","description":"List all leads and customers assigned to a promotion - find promotion by `ref_id`","uniqueKey":"","typeLabel":"string"}},"338647f1-e19c-41ce-8e5a-6a317d8b3298":{"name":"promoter_id","in":"query","description":"List all leads and customers assigned to a promoter","schema":{"type":"string","description":"List all leads and customers assigned to a promoter","uniqueKey":"","typeLabel":"string"}},"46b98690-e593-47c7-9695-92bd046949d0":{"name":"campaign_id","in":"query","description":"List all leads and customers in a campaign","schema":{"type":"string","description":"List all leads and customers in a campaign","uniqueKey":"","typeLabel":"string"}}},"responses":{"6112d446-a666-4897-9f6a-08304754384a":{"description":"Get the list of leads and customers response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The lead's ID inside FirstPromoter","type":"integer","uniqueKey":"items.[INDEX].id","typeLabel":"integer"},"state":{"description":"The lead's or customer's status","type":"string","enum":["signup","active","subscribed","denied","cancelled"],"uniqueKey":"items.[INDEX].state","typeLabel":"enum\u003cstring>"},"uid":{"description":"Your lead/customer's user ID inside your application.","uniqueKey":"items.[INDEX].uid","typeLabel":"any"},"email":{"description":"The lead's or customer's email","type":"string","format":"email","uniqueKey":"items.[INDEX].email","typeLabel":"string\u003cemail>"},"customer_since":{"description":"ISO date string at which the lead converted to a customer.","type":"string","uniqueKey":"items.[INDEX].customer_since","typeLabel":"string"},"cancelled_at":{"description":"ISO date string at which the lead/customer cancelled","type":"string","uniqueKey":"items.[INDEX].cancelled_at","typeLabel":"string"},"plan_name":{"type":"string","uniqueKey":"items.[INDEX].plan_name","typeLabel":"string"},"suspicion":{"type":"string","uniqueKey":"items.[INDEX].suspicion","typeLabel":"string"},"username":{"type":"string","uniqueKey":"items.[INDEX].username","typeLabel":"string"},"website":{"type":"string","uniqueKey":"items.[INDEX].website","typeLabel":"string"},"created_at":{"description":"ISO date string at which the lead/customer signed up","type":"string","uniqueKey":"items.[INDEX].created_at","typeLabel":"string"},"split_promotion_id":{"oneOf":[{}],"uniqueKey":"items.[INDEX].split_promotion_id","typeLabel":"any"},"custom_fields":{"oneOf":[{}],"uniqueKey":"items.[INDEX].custom_fields","typeLabel":"any"},"split_percentage_value":{"oneOf":[{}],"uniqueKey":"items.[INDEX].split_percentage_value","typeLabel":"any"},"visitor_sub_id":{"oneOf":[{}],"uniqueKey":"items.[INDEX].visitor_sub_id","typeLabel":"any"},"promotion":{"type":"object","properties":{"id":{"description":"ID of the promotion.","type":"number","uniqueKey":"items.[INDEX].promotion.id","typeLabel":"number"},"status":{"description":"Current offer status.","type":"string","uniqueKey":"items.[INDEX].promotion.status","typeLabel":"string"},"ref_id":{"type":"string","uniqueKey":"items.[INDEX].promotion.ref_id","typeLabel":"string"},"promo_code":{"description":"The unique coupon id or coupon code from your billing provider to assign to this affiliate for coupon tracking. This is also known as promo code.","type":"string","uniqueKey":"items.[INDEX].promotion.promo_code","typeLabel":"string"},"customer_promo_code":{"description":"This is discount code/promotion code your customer used or applied on your checkout page. This is also known as display code","type":"string","uniqueKey":"items.[INDEX].promotion.customer_promo_code","typeLabel":"string"},"target_reached_at":{"type":"string","uniqueKey":"items.[INDEX].promotion.target_reached_at","typeLabel":"string"},"promoter_id":{"description":"ID of the promoter/affiliate.","type":"number","uniqueKey":"items.[INDEX].promotion.promoter_id","typeLabel":"number"},"campaign_id":{"description":"ID of the campaign where the promotion runs.","type":"number","uniqueKey":"items.[INDEX].promotion.campaign_id","typeLabel":"number"},"referral_link":{"description":"Promoter's referral link","type":"string","uniqueKey":"items.[INDEX].promotion.referral_link","typeLabel":"string"},"current_offer":{"type":"object","properties":{"id":{"description":"The reward id","type":"number","uniqueKey":"items.[INDEX].promotion.current_offer.id","typeLabel":"number"},"name":{"description":"The reward name","type":"string","uniqueKey":"items.[INDEX].promotion.current_offer.name","typeLabel":"string"},"amount":{"description":"The reward amount","type":"number","uniqueKey":"items.[INDEX].promotion.current_offer.amount","typeLabel":"number"},"unit":{"description":"The reward unit (e.g., 'credits', 'free_months', 'cash').","type":"string","uniqueKey":"items.[INDEX].promotion.current_offer.unit","typeLabel":"string"},"default_promo_code":{"type":"string","uniqueKey":"items.[INDEX].promotion.current_offer.default_promo_code","typeLabel":"string"}},"uniqueKey":"items.[INDEX].promotion.current_offer","typeLabel":"object"},"current_referral_reward":{"type":"object","properties":{"id":{"type":"number","uniqueKey":"items.[INDEX].promotion.current_referral_reward.id","typeLabel":"number"},"amount":{"type":"number","uniqueKey":"items.[INDEX].promotion.current_referral_reward.amount","typeLabel":"number"},"unit":{"type":"string","uniqueKey":"items.[INDEX].promotion.current_referral_reward.unit","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].promotion.current_referral_reward.name","typeLabel":"string"},"per_of_sale":{"type":"number","uniqueKey":"items.[INDEX].promotion.current_referral_reward.per_of_sale","typeLabel":"number"},"default_promo_code":{"type":"string","uniqueKey":"items.[INDEX].promotion.current_referral_reward.default_promo_code","typeLabel":"string"}},"uniqueKey":"items.[INDEX].promotion.current_referral_reward","typeLabel":"object"},"current_promotion_reward":{"type":"object","uniqueKey":"items.[INDEX].promotion.current_promotion_reward","typeLabel":"object"},"current_target_reward":{"type":"object","uniqueKey":"items.[INDEX].promotion.current_target_reward","typeLabel":"object"},"campaign_name":{"type":"string","uniqueKey":"items.[INDEX].promotion.campaign_name","typeLabel":"string"},"hidden":{"type":"boolean","uniqueKey":"items.[INDEX].promotion.hidden","typeLabel":"boolean"},"visitors_count":{"type":"number","uniqueKey":"items.[INDEX].promotion.visitors_count","typeLabel":"number"},"leads_count":{"type":"number","uniqueKey":"items.[INDEX].promotion.leads_count","typeLabel":"number"},"customers_count":{"type":"number","uniqueKey":"items.[INDEX].promotion.customers_count","typeLabel":"number"},"refunds_count":{"type":"number","uniqueKey":"items.[INDEX].promotion.refunds_count","typeLabel":"number"},"cancellations_count":{"type":"number","uniqueKey":"items.[INDEX].promotion.cancellations_count","typeLabel":"number"},"sales_count":{"type":"number","uniqueKey":"items.[INDEX].promotion.sales_count","typeLabel":"number"},"sales_total":{"type":"number","uniqueKey":"items.[INDEX].promotion.sales_total","typeLabel":"number"},"refunds_total":{"type":"number","uniqueKey":"items.[INDEX].promotion.refunds_total","typeLabel":"number"},"active_customers_count":{"type":"number","uniqueKey":"items.[INDEX].promotion.active_customers_count","typeLabel":"number"}},"uniqueKey":"items.[INDEX].promotion","typeLabel":"object"},"promoter":{"type":"object","properties":{"id":{"description":"Promoter's id","type":"integer","uniqueKey":"items.[INDEX].promoter.id","typeLabel":"integer"},"status":{"description":"Promoter's status","type":"string","enum":["approved","pending","denied"],"uniqueKey":"items.[INDEX].promoter.status","typeLabel":"enum\u003cstring>"},"cust_id":{"description":"Customer/user ID of the promoter inside your application. This will be included in the webhook event and can be used to identify the promoter in your system if you subscribe for FirstPromoter's 'promoter_accepted' webhook.","uniqueKey":"items.[INDEX].promoter.cust_id","typeLabel":"any"},"email":{"description":"Promoter's email","type":"string","uniqueKey":"items.[INDEX].promoter.email","typeLabel":"string"},"created_at":{"description":"ISO date string at which the promoter signed up","type":"string","uniqueKey":"items.[INDEX].promoter.created_at","typeLabel":"string"},"temp_password":{"description":"A temporary password the promoter can use to log in to their dashboard if you don't use authentication tokens(auth_token) to sign promoters in automatically.","type":"string","uniqueKey":"items.[INDEX].promoter.temp_password","typeLabel":"string"},"default_promotion_id":{"description":"Promoter's default promotion id","type":"number","uniqueKey":"items.[INDEX].promoter.default_promotion_id","typeLabel":"number"},"pref":{"description":"Promoter's parent referral id.","type":"string","uniqueKey":"items.[INDEX].promoter.pref","typeLabel":"string"},"default_ref_id":{"description":"Promoter's default referral id","type":"string","uniqueKey":"items.[INDEX].promoter.default_ref_id","typeLabel":"string"},"note":{"description":"A note/description of promoter","type":"string","uniqueKey":"items.[INDEX].promoter.note","typeLabel":"string"},"w8_form_url":{"oneOf":[{}],"uniqueKey":"items.[INDEX].promoter.w8_form_url","typeLabel":"any"},"w9_form_url":{"oneOf":[{}],"uniqueKey":"items.[INDEX].promoter.w9_form_url","typeLabel":"any"},"parent_promoter_id":{"description":"Parent promoter id","type":"string","uniqueKey":"items.[INDEX].promoter.parent_promoter_id","typeLabel":"string"},"earnings_balance":{"description":"Promoter's earnings balance","type":"object","uniqueKey":"items.[INDEX].promoter.earnings_balance","typeLabel":"object"},"current_balance":{"description":"Promoter's current balance","type":"object","uniqueKey":"items.[INDEX].promoter.current_balance","typeLabel":"object"},"paid_balance":{"description":"Promoter's paid balance","type":"object","uniqueKey":"items.[INDEX].promoter.paid_balance","typeLabel":"object"},"auth_token":{"description":"Authentication token generated when the promoter was created","type":"string","uniqueKey":"items.[INDEX].promoter.auth_token","typeLabel":"string"}},"uniqueKey":"items.[INDEX].promoter","typeLabel":"object"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":123,"state":"signup","uid":"\u003cunknown>","email":"jsmith@example.com","customer_since":"\u003cstring>","cancelled_at":"\u003cstring>","plan_name":"\u003cstring>","suspicion":"\u003cstring>","username":"\u003cstring>","website":"\u003cstring>","created_at":"\u003cstring>","split_promotion_id":"\u003cunknown>","custom_fields":"\u003cunknown>","split_percentage_value":"\u003cunknown>","visitor_sub_id":"\u003cunknown>","promotion":{"id":123,"status":"\u003cstring>","ref_id":"\u003cstring>","promo_code":"\u003cstring>","customer_promo_code":"\u003cstring>","target_reached_at":"\u003cstring>","promoter_id":123,"campaign_id":123,"referral_link":"\u003cstring>","current_offer":{"id":123,"name":"\u003cstring>","amount":123,"unit":"\u003cstring>","default_promo_code":"\u003cstring>"},"current_referral_reward":{"id":123,"amount":123,"unit":"\u003cstring>","name":"\u003cstring>","per_of_sale":123,"default_promo_code":"\u003cstring>"},"current_promotion_reward":{},"current_target_reward":{},"campaign_name":"\u003cstring>","hidden":true,"visitors_count":123,"leads_count":123,"customers_count":123,"refunds_count":123,"cancellations_count":123,"sales_count":123,"sales_total":123,"refunds_total":123,"active_customers_count":123},"promoter":{"id":123,"status":"approved","cust_id":"\u003cunknown>","email":"\u003cstring>","created_at":"\u003cstring>","temp_password":"\u003cstring>","default_promotion_id":123,"pref":"\u003cstring>","default_ref_id":"\u003cstring>","note":"\u003cstring>","w8_form_url":"\u003cunknown>","w9_form_url":"\u003cunknown>","parent_promoter_id":"\u003cstring>","earnings_balance":{},"current_balance":{},"paid_balance":{},"auth_token":"\u003cstring>"}}]}},"exampleType":"generated"}},"exampleType":"generated"},"7b37c865-0725-41ff-b7b1-1eb1b4660236":{"description":"Authentication error 401 response","content":{"application/json":{"schema":{"type":"string","example":"Bad credentials","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Bad credentials"}},"exampleType":"generated"}},"exampleType":"generated"},"d57f5d77-5f59-43f8-8489-363d7b3aa639":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"example":{"error":"Promotion not found."},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Promotion not found."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6a9022dc-7824-4f97-a627-6379c189be69":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"5927f42c-1c12-4305-9732-67b507eeb01a":{"url":"https://firstpromoter.com/api/v1/leads"}},"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/leads-api/openapi-leads.json"},"subdomain":"firstpromoter","siteName":"FirstPromoter Docs","title":"List leads/customers - FirstPromoter Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/introduction","matchLevel":4},"v1":{"href":"/api-reference-v1/leads-api/list","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-08-07T12:33:18.599Z","originalFileLocation":"api-reference-v1/leads-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 the leads and customers assigned to a promotion, promoter, campaign or entire account using the API. Pagination details are held on response headers. Add --include option on curl request to see the pagination details format and links to next pages.HTTP Request GET https://firstpromoter.com/api/v1/leads/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 leads/customers - FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"With this endpoint you can list all the leads and customers assigned to a promotion, promoter, campaign or entire account using the API. Pagination details are held on response headers. Add --include option on curl request to see the pagination details format and links to next pages.HTTP Request GET https://firstpromoter.com/api/v1/leads/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/leads-api/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firstpromoter.mintlify.app/_mintlify/api/og/v2?division=Leads\u0026amp;title=List+leads%2Fcustomers\u0026amp;description=With+this+endpoint+you+can+list+all+the+leads+and+customers+assigned+to+a+promotion%2C+promoter%2C+campaign+or+entire+account+using+the+API.+%3CNote%3EPagination+detail\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=ca1541c0293eb2cfa0cdf6983a9895159ac41fb47e836f80646df00dd6676b9b\">\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 leads/customers - FirstPromoter Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"With this endpoint you can list all the leads and customers assigned to a promotion, promoter, campaign or entire account using the API. Pagination details are held on response headers. Add --include option on curl request to see the pagination details format and links to next pages.HTTP Request GET https://firstpromoter.com/api/v1/leads/list\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstpromoter.mintlify.app/_mintlify/api/og/v2?division=Leads\u0026amp;title=List+leads%2Fcustomers\u0026amp;description=With+this+endpoint+you+can+list+all+the+leads+and+customers+assigned+to+a+promotion%2C+promoter%2C+campaign+or+entire+account+using+the+API.+%3CNote%3EPagination+detail\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=ca1541c0293eb2cfa0cdf6983a9895159ac41fb47e836f80646df00dd6676b9b\">\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/leads-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/leads-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/leads-api/list#webpage\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/leads-api/list\",\"name\":\"List leads/customers\",\"description\":\"With this endpoint you can list all the leads and customers assigned to a promotion, promoter, campaign or entire account using the API. Pagination details are held on response headers. Add --include option on curl request to see the pagination details format and links to next pages.HTTP Request GET https://firstpromoter.com/api/v1/leads/list\",\"dateModified\":\"2025-08-07T12:33:18.599Z\",\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/leads-api/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/leads-api/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Leads\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/leads-api/update\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List leads/customers\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/leads-api/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/leads-api/list#apireference\",\"headline\":\"List leads/customers\",\"name\":\"List leads/customers\",\"description\":\"With this endpoint you can list all the leads and customers assigned to a promotion, promoter, campaign or entire account using the API. Pagination details are held on response headers. Add --include option on curl request to see the pagination details format and links to next pages.HTTP Request GET https://firstpromoter.com/api/v1/leads/list\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/leads-api/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/leads-api/list#webpage\"},\"dateModified\":\"2025-08-07T12:33:18.599Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"FirstPromoter Docs","nav":{"global":null,"versions":[{"version":"v2","pages":[{"title":"v2","href":"/introduction"}]},{"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","description":"Use this to update a lead/customer details from FirstPromoter using the API. You can find the lead either by `id`, `uid` or `email` \u003cTip>**HTTP Request** \u003cbr/> `PUT https://firstpromoter.com/api/v1/leads/update`\u003c/Tip>","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","description":"Show the lead/customer details from FirstPromoter using the API. You can find the referral either by `id` , `uid` or `email` \u003cTip>**HTTP Request** \u003cbr/> `GET https://firstpromoter.com/api/v1/leads/show`\u003c/Tip>","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","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","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/"}]}]},"title":"List leads/customers - FirstPromoter Docs","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}