Use this endpoint to list your promoters using the API. The response will return the promoters as JSON array.
Pagination details are held on response headers. Add —include option on curl request to see the pagination details format and links to next pages.
Authorizations
X-API-KEY
string
header
required
Query Parameters
campaign_id
string
List all promoters accepted to a specific campaign.
Response
List Promoters response
id
integer
The promoter's ID inside FirstPromoter
status
enum<string>
Promoter's status
Available options:
approved,
pending,
denied
cust_id
string
Your customer's user ID inside your application/system for the promoter. 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 webhooks.
email
string
Promoter's email
created_at
string
ISO date string when the promoter signed up
temp_password
string
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.
default_promotion_id
number
Promoter's default promotion id
Example:
128833
pref
string
Promoter's parent referral id.
default_ref_id
string
Promoter's default referral id
note
string
A note/description of promoter
w8_form_url
string
The w8 form url
w9_form_url
string
The w9 form url
parent_promoter_id
string
Parent promoter id
earnings_balance
object
Promoter's earnings balance. This object can contain cash, credits, discount_per
Show child attributes
current_balance
object
Promoter's current balance. This object can contain cash, credits, discount_per
Show child attributes
paid_balance
object
Promoter's paid balance. This object can contain cash, credits, discount_per
Show child attributes
auth_token
string
Authentication token generated when the promoter was created
profile
object
Show child attributes
promotions
object[]
Show child attributes
custom_fields
object | null
Key-value pairs of custom fields configured for this promoter
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FirstPromoter Docs","description":"FirstPromoter developer docs: set up affiliate and referral tracking, connect billing and payout providers, receive webhooks, and use the REST API and MCP server.","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","facebook":"https://www.facebook.com/firstpromoter","github":"https://github.com/firstpromoter"},"links":[{"header":"Product","items":[{"label":"Features","href":"https://firstpromoter.com/features"},{"label":"Integrations","href":"https://firstpromoter.com/integrations"},{"label":"Pricing","href":"https://firstpromoter.com/pricing"},{"label":"Changelog","href":"https://changelog.firstpromoter.com/"},{"label":"Stripe app","href":"https://marketplace.stripe.com/apps/firstpromoter"}]},{"header":"Company","items":[{"label":"About us","href":"https://firstpromoter.com/about-us"},{"label":"Careers","href":"https://firstpromoter.com/careers"},{"label":"Blog","href":"https://firstpromoter.com/blog"},{"label":"Case studies","href":"https://firstpromoter.com/casestudy"},{"label":"Affiliate program","href":"https://firstpromoter.com/affiliate-program"}]},{"header":"Help","items":[{"label":"Help center","href":"https://help.firstpromoter.com/en"},{"label":"Contact support","href":"mailto:support@firstpromoter.com"},{"label":"Log in","href":"https://app.firstpromoter.com/login"}]},{"header":"Legal","items":[{"label":"Privacy policy","href":"https://firstpromoter.com/privacy"},{"label":"Terms of service","href":"https://firstpromoter.com/terms"}]}]},"search":{"prompt":"Search guides, integrations and API endpoints..."},"seo":{"metatags":{"canonical":"https://docs.firstpromoter.com"},"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp"],"display":"header"},"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":"6b006a04286e5a4832624336","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"Documentation","count":253},{"language":"default","tag":"API Reference","count":83},{"language":"default","tag":"Integration Options","count":43},{"language":"default","tag":"Affiliate API Reference","count":32},{"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}]},"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":"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":"site-roles","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},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference-v1/promoters-api/list","slug":"/api-reference-v1/promoters-api/list","pageMetadata":{"title":"List promoters","description":"List promoters, optionally for one campaign, with pagination in the response headers (legacy v1 API).","openapi":"openapi-promoters GET /list","href":"/api-reference-v1/promoters-api/list"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"List promoters, optionally for one campaign, with pagination in the response headers (legacy v1 API).\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use this endpoint to list your promoters using the API. The response will return the promoters as JSON array.`}),`\n`,_jsx(Note,{children:`Pagination details are held on response headers. Add —include option on curl request to see the pagination details format and links to next pages.`})]})}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":"List promoters","description":"List promoters, optionally for one campaign, with pagination in the response headers (legacy v1 API).","openapi":"openapi-promoters GET /list","href":"/api-reference-v1/promoters-api/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstpromoter/8ad42af542d542c7/downloadables/fpr-prox.js"],"openApiReferenceData":{"operation":{"description":"List promoters, optionally for one campaign, with pagination in the response headers (legacy v1 API).","parameters":["cf717b4e-2337-43e2-9a84-74e157ea72b7"],"responses":{"200":"f2ffa11d-aca2-4e8d-b641-959e0c694ceb","401":"a6baafad-e335-45a6-9b73-257382b34f1e","422":"5a1beb8c-7cf1-44c5-9dc0-93b4f54edcba"},"method":"get","type":"path","servers":["cf343685-35f1-4bf3-bc4e-8859f920d6d8"],"security":["269911f4-0f00-42c0-8c6f-e9436c156c27"],"path":"/list","baseUrlOptions":["https://firstpromoter.com/api/v1/promoters"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cf717b4e-2337-43e2-9a84-74e157ea72b7":{"name":"campaign_id","in":"query","description":"List all promoters accepted to a specific campaign.","schema":{"type":"string","description":"List all promoters accepted to a specific campaign.","uniqueKey":"","typeLabel":"string"}}},"responses":{"f2ffa11d-aca2-4e8d-b641-959e0c694ceb":{"description":"List Promoters response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The promoter's ID inside FirstPromoter","type":"integer","uniqueKey":"items.[INDEX].id","typeLabel":"integer"},"status":{"description":"Promoter's status","type":"string","enum":["approved","pending","denied"],"uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"cust_id":{"description":"Your customer's user ID inside your application/system for the promoter. 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 webhooks.","type":"string","uniqueKey":"items.[INDEX].cust_id","typeLabel":"string"},"email":{"description":"Promoter's email","type":"string","uniqueKey":"items.[INDEX].email","typeLabel":"string"},"created_at":{"description":"ISO date string when the promoter signed up","type":"string","uniqueKey":"items.[INDEX].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].temp_password","typeLabel":"string"},"default_promotion_id":{"description":"Promoter's default promotion id","type":"number","example":128833,"uniqueKey":"items.[INDEX].default_promotion_id","typeLabel":"number"},"pref":{"description":"Promoter's parent referral id.","type":"string","uniqueKey":"items.[INDEX].pref","typeLabel":"string"},"default_ref_id":{"description":"Promoter's default referral id","type":"string","uniqueKey":"items.[INDEX].default_ref_id","typeLabel":"string"},"note":{"description":"A note/description of promoter","type":"string","uniqueKey":"items.[INDEX].note","typeLabel":"string"},"w8_form_url":{"description":"The w8 form url","type":"string","uniqueKey":"items.[INDEX].w8_form_url","typeLabel":"string"},"w9_form_url":{"description":"The w9 form url","type":"string","uniqueKey":"items.[INDEX].w9_form_url","typeLabel":"string"},"parent_promoter_id":{"description":"Parent promoter id","type":"string","uniqueKey":"items.[INDEX].parent_promoter_id","typeLabel":"string"},"earnings_balance":{"description":"Promoter's earnings balance. This object can contain `cash`, `credits`, `discount_per` ","type":"object","properties":{"cash":{"description":"The cash earnings","type":"integer","example":3000,"uniqueKey":"items.[INDEX].earnings_balance.cash","typeLabel":"integer"},"credits":{"description":"The earning credits","type":"integer","example":300,"uniqueKey":"items.[INDEX].earnings_balance.credits","typeLabel":"integer"},"discount_per":{"description":"The earning discount percentage","type":"integer","example":30,"uniqueKey":"items.[INDEX].earnings_balance.discount_per","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].earnings_balance","typeLabel":"object"},"current_balance":{"description":"Promoter's current balance. This object can contain `cash`, `credits`, `discount_per` ","type":"object","properties":{"cash":{"description":"The current cash balance","type":"integer","example":1000,"uniqueKey":"items.[INDEX].current_balance.cash","typeLabel":"integer"},"credits":{"description":"The current credits","type":"integer","example":200,"uniqueKey":"items.[INDEX].current_balance.credits","typeLabel":"integer"},"discount_per":{"description":"The current discount percentage","type":"integer","example":15,"uniqueKey":"items.[INDEX].current_balance.discount_per","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].current_balance","typeLabel":"object"},"paid_balance":{"description":"Promoter's paid balance. This object can contain `cash`, `credits`, `discount_per`","type":"object","properties":{"cash":{"description":"The cash paid","type":"integer","example":2000,"uniqueKey":"items.[INDEX].paid_balance.cash","typeLabel":"integer"},"credits":{"description":"The credits given","type":"integer","example":100,"uniqueKey":"items.[INDEX].paid_balance.credits","typeLabel":"integer"},"discount_per":{"description":"The discount percentage given","type":"integer","example":15,"uniqueKey":"items.[INDEX].paid_balance.discount_per","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].paid_balance","typeLabel":"object"},"auth_token":{"description":"Authentication token generated when the promoter was created","type":"string","uniqueKey":"items.[INDEX].auth_token","typeLabel":"string"},"profile":{"type":"object","properties":{"first_name":{"description":"Promoter's first name","type":"string","uniqueKey":"items.[INDEX].profile.first_name","typeLabel":"string"},"last_name":{"description":"Promoter's last name","type":"string","uniqueKey":"items.[INDEX].profile.last_name","typeLabel":"string"},"website":{"description":"Promoter's website","type":"string","uniqueKey":"items.[INDEX].profile.website","typeLabel":"string"},"company_name":{"description":"Promoter's company name","type":"string","uniqueKey":"items.[INDEX].profile.company_name","typeLabel":"string"},"phone_number":{"description":"Promoter's phone number","type":"string","uniqueKey":"items.[INDEX].profile.phone_number","typeLabel":"string"},"address":{"description":"Promoter's address","type":"string","uniqueKey":"items.[INDEX].profile.address","typeLabel":"string"},"vat_id":{"description":"Promoter's vat id","type":"string","uniqueKey":"items.[INDEX].profile.vat_id","typeLabel":"string"},"country":{"description":"Promoter's country","type":"string","uniqueKey":"items.[INDEX].profile.country","typeLabel":"string"},"paypal_email":{"description":"Promoter's Paypal email address","type":"string","uniqueKey":"items.[INDEX].profile.paypal_email","typeLabel":"string"},"avatar_url":{"description":"URL of the profile picture promoters can see on their dashboard","type":"string","uniqueKey":"items.[INDEX].profile.avatar_url","typeLabel":"string"},"description":{"description":"A note/description of promoter","type":"string","uniqueKey":"items.[INDEX].profile.description","typeLabel":"string"},"social_accounts":{"type":"object","properties":{"twitter":{"type":"object","properties":{"url":{"description":"Promoter's twitter url","type":"string","uniqueKey":"items.[INDEX].profile.social_accounts.twitter.url","typeLabel":"string"}},"uniqueKey":"items.[INDEX].profile.social_accounts.twitter","typeLabel":"object"},"youtube":{"type":"object","properties":{"url":{"description":"Promoter's youtube url","type":"string","uniqueKey":"items.[INDEX].profile.social_accounts.youtube.url","typeLabel":"string"}},"uniqueKey":"items.[INDEX].profile.social_accounts.youtube","typeLabel":"object"},"facebook":{"type":"object","properties":{"url":{"description":"Promoter's Facebook url","type":"string","uniqueKey":"items.[INDEX].profile.social_accounts.facebook.url","typeLabel":"string"}},"uniqueKey":"items.[INDEX].profile.social_accounts.facebook","typeLabel":"object"},"linkedin":{"type":"object","properties":{"url":{"description":"Promoter's linkedin url","type":"string","uniqueKey":"items.[INDEX].profile.social_accounts.linkedin.url","typeLabel":"string"}},"uniqueKey":"items.[INDEX].profile.social_accounts.linkedin","typeLabel":"object"},"instagram":{"type":"object","properties":{"url":{"description":"Promoter's instagram url","type":"string","uniqueKey":"items.[INDEX].profile.social_accounts.instagram.url","typeLabel":"string"}},"uniqueKey":"items.[INDEX].profile.social_accounts.instagram","typeLabel":"object"}},"uniqueKey":"items.[INDEX].profile.social_accounts","typeLabel":"object"}},"uniqueKey":"items.[INDEX].profile","typeLabel":"object"},"promotions":{"type":"array","items":{"type":"object","properties":{"id":{"description":"ID of the promotion.","type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].id","typeLabel":"number"},"status":{"description":"Current offer status.","type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].status","typeLabel":"string"},"ref_id":{"type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].ref_id","typeLabel":"string"},"promo_code":{"description":" Unique promo code from your billing provider to assign to this affiliate for coupon tracking. This is also known as the `Coupon Code` or `Coupon ID`","type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].promo_code","typeLabel":"string"},"customer_promo_code":{"description":"Customer promo code from your billing provider assigned to this affiliate for coupon tracking. This is also known as `discount code` or `promotion code` or `display code`. This is the code your customer(s) used on the checkout form/page.","type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].customer_promo_code","typeLabel":"string"},"target_reached_at":{"type":"object","uniqueKey":"items.[INDEX].promotions.items.[INDEX].target_reached_at","typeLabel":"object"},"promoter_id":{"description":"ID of the promoter/affiliate.","type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].promoter_id","typeLabel":"number"},"campaign_id":{"description":"ID of the campaign where the promotion runs.","type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].campaign_id","typeLabel":"number"},"referral_link":{"description":"Promoter's referral link","type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].referral_link","typeLabel":"string"},"current_offer":{"type":"object","properties":{"id":{"description":"The reward id","type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_offer.id","typeLabel":"number"},"name":{"description":"The reward name","type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_offer.name","typeLabel":"string"},"amount":{"description":"The reward amount","type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_offer.amount","typeLabel":"number"},"unit":{"description":"The reward unit (e.g., 'credits', 'free_months', 'cash').","type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_offer.unit","typeLabel":"string"},"default_promo_code":{"type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_offer.default_promo_code","typeLabel":"string"}},"uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_offer","typeLabel":"object"},"current_referral_reward":{"type":"object","properties":{"id":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_referral_reward.id","typeLabel":"number"},"amount":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_referral_reward.amount","typeLabel":"number"},"unit":{"type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_referral_reward.unit","typeLabel":"string"},"name":{"type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_referral_reward.name","typeLabel":"string"},"per_of_sale":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_referral_reward.per_of_sale","typeLabel":"number"},"default_promo_code":{"type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_referral_reward.default_promo_code","typeLabel":"string"}},"uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_referral_reward","typeLabel":"object"},"current_promotion_reward":{"type":"object","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_promotion_reward","typeLabel":"object"},"current_target_reward":{"type":"object","uniqueKey":"items.[INDEX].promotions.items.[INDEX].current_target_reward","typeLabel":"object"},"campaign_name":{"type":"string","uniqueKey":"items.[INDEX].promotions.items.[INDEX].campaign_name","typeLabel":"string"},"hidden":{"type":"boolean","uniqueKey":"items.[INDEX].promotions.items.[INDEX].hidden","typeLabel":"boolean"},"visitors_count":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].visitors_count","typeLabel":"number"},"leads_count":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].leads_count","typeLabel":"number"},"customers_count":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].customers_count","typeLabel":"number"},"refunds_count":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].refunds_count","typeLabel":"number"},"cancellations_count":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].cancellations_count","typeLabel":"number"},"sales_count":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].sales_count","typeLabel":"number"},"sales_total":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].sales_total","typeLabel":"number"},"refunds_total":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].refunds_total","typeLabel":"number"},"active_customers_count":{"type":"number","uniqueKey":"items.[INDEX].promotions.items.[INDEX].active_customers_count","typeLabel":"number"}},"uniqueKey":"items.[INDEX].promotions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].promotions","typeLabel":"object[]"},"custom_fields":{"oneOf":[{"type":"object","description":"Key-value pairs of custom fields configured for this promoter","uniqueKey":"items.[INDEX].custom_fields.oneOf.0","typeLabel":"object"},{"type":"null","description":"Key-value pairs of custom fields configured for this promoter","uniqueKey":"items.[INDEX].custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].custom_fields","typeLabel":"object | null"},"promo_codes":{"type":"array","description":"Promo codes associated with this promoter","items":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"items.[INDEX].promo_codes.items.[INDEX].id","typeLabel":"integer"},"code":{"type":"string","uniqueKey":"items.[INDEX].promo_codes.items.[INDEX].code","typeLabel":"string"},"reward":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"items.[INDEX].promo_codes.items.[INDEX].reward.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"items.[INDEX].promo_codes.items.[INDEX].reward.name","typeLabel":"string"}},"uniqueKey":"items.[INDEX].promo_codes.items.[INDEX].reward","typeLabel":"object"}},"uniqueKey":"items.[INDEX].promo_codes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].promo_codes","typeLabel":"object[]"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"example":[{"id":8815216,"status":"active","cust_id":null,"email":"mintly@mailinator.com","created_at":"2024-09-11T14:20:50.403Z","temp_password":"1y-JxB","default_promotion_id":10116083,"pref":"y3fvz4o","default_ref_id":"heubv","note":null,"w8_form_url":null,"w9_form_url":null,"parent_promoter_id":null,"earnings_balance":null,"current_balance":null,"paid_balance":null,"auth_token":"X9edc-csF56dt8qB6KwcDyPhVdMUtWXY","profile":{"id":8862106,"first_name":null,"last_name":null,"website":null,"company_name":null,"phone_number":null,"address":null,"vat_id":null,"country":null,"paypal_email":null,"avatar_url":null,"description":null,"social_accounts":{}},"promotions":[{"id":10116083,"status":"offer_running","ref_id":"heubv","promo_code":null,"customer_promo_code":null,"target_reached_at":null,"promoter_id":8815216,"campaign_id":26127,"referral_link":"https://lastechworld.com?fpr=heubv","current_offer":{"id":140358,"name":"1 free subscription months","amount":1,"unit":"free_months","default_promo_code":""},"current_referral_reward":{"id":140359,"amount":1,"type":"per_referral","unit":"free_months","name":"1 free subscription months","per_of_sale":0,"default_promo_code":""},"current_promotion_reward":null,"current_target_reward":null,"campaign_name":"Make Campaign","hidden":false,"visitors_count":0,"leads_count":0,"customers_count":0,"refunds_count":0,"cancellations_count":0,"sales_count":0,"sales_total":0,"refunds_total":0,"active_customers_count":0}]},{"id":8809547,"status":"active","cust_id":null,"email":"prince+grace@mailinator.com","created_at":"2024-09-09T22:01:16.909Z","temp_password":"yx4_LJ","default_promotion_id":10108807,"pref":"udicfs6","default_ref_id":"ljysw","note":null,"w8_form_url":null,"w9_form_url":null,"parent_promoter_id":null,"earnings_balance":null,"current_balance":null,"paid_balance":null,"auth_token":"kitwmn6ER9RzfZ5Mn9Ksv8PFxnpAzwBT","profile":{"id":8856384,"first_name":null,"last_name":null,"website":null,"company_name":null,"phone_number":null,"address":null,"vat_id":null,"country":null,"paypal_email":null,"avatar_url":null,"description":null,"social_accounts":{}},"promotions":[{"id":10108807,"status":"offer_running","ref_id":"ljysw","promo_code":null,"customer_promo_code":null,"target_reached_at":null,"promoter_id":8809547,"campaign_id":26127,"referral_link":"https://lastechworld.com?fpr=ljysw","current_offer":{"id":140358,"name":"1 free subscription months","amount":1,"unit":"free_months","default_promo_code":""},"current_referral_reward":{"id":140359,"amount":1,"type":"per_referral","unit":"free_months","name":"1 free subscription months","per_of_sale":0,"default_promo_code":""},"current_promotion_reward":null,"current_target_reward":null,"campaign_name":"Make Campaign","hidden":false,"visitors_count":0,"leads_count":0,"customers_count":0,"refunds_count":0,"cancellations_count":0,"sales_count":0,"sales_total":0,"refunds_total":0,"active_customers_count":0}]}],"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":8815216,"status":"active","cust_id":null,"email":"mintly@mailinator.com","created_at":"2024-09-11T14:20:50.403Z","temp_password":"1y-JxB","default_promotion_id":10116083,"pref":"y3fvz4o","default_ref_id":"heubv","note":null,"w8_form_url":null,"w9_form_url":null,"parent_promoter_id":null,"earnings_balance":null,"current_balance":null,"paid_balance":null,"auth_token":"X9edc-csF56dt8qB6KwcDyPhVdMUtWXY","profile":{"id":8862106,"first_name":null,"last_name":null,"website":null,"company_name":null,"phone_number":null,"address":null,"vat_id":null,"country":null,"paypal_email":null,"avatar_url":null,"description":null,"social_accounts":{}},"promotions":[{"id":10116083,"status":"offer_running","ref_id":"heubv","promo_code":null,"customer_promo_code":null,"target_reached_at":null,"promoter_id":8815216,"campaign_id":26127,"referral_link":"https://lastechworld.com?fpr=heubv","current_offer":{"id":140358,"name":"1 free subscription months","amount":1,"unit":"free_months","default_promo_code":""},"current_referral_reward":{"id":140359,"amount":1,"type":"per_referral","unit":"free_months","name":"1 free subscription months","per_of_sale":0,"default_promo_code":""},"current_promotion_reward":null,"current_target_reward":null,"campaign_name":"Make Campaign","hidden":false,"visitors_count":0,"leads_count":0,"customers_count":0,"refunds_count":0,"cancellations_count":0,"sales_count":0,"sales_total":0,"refunds_total":0,"active_customers_count":0}]},{"id":8809547,"status":"active","cust_id":null,"email":"prince+grace@mailinator.com","created_at":"2024-09-09T22:01:16.909Z","temp_password":"yx4_LJ","default_promotion_id":10108807,"pref":"udicfs6","default_ref_id":"ljysw","note":null,"w8_form_url":null,"w9_form_url":null,"parent_promoter_id":null,"earnings_balance":null,"current_balance":null,"paid_balance":null,"auth_token":"kitwmn6ER9RzfZ5Mn9Ksv8PFxnpAzwBT","profile":{"id":8856384,"first_name":null,"last_name":null,"website":null,"company_name":null,"phone_number":null,"address":null,"vat_id":null,"country":null,"paypal_email":null,"avatar_url":null,"description":null,"social_accounts":{}},"promotions":[{"id":10108807,"status":"offer_running","ref_id":"ljysw","promo_code":null,"customer_promo_code":null,"target_reached_at":null,"promoter_id":8809547,"campaign_id":26127,"referral_link":"https://lastechworld.com?fpr=ljysw","current_offer":{"id":140358,"name":"1 free subscription months","amount":1,"unit":"free_months","default_promo_code":""},"current_referral_reward":{"id":140359,"amount":1,"type":"per_referral","unit":"free_months","name":"1 free subscription months","per_of_sale":0,"default_promo_code":""},"current_promotion_reward":null,"current_target_reward":null,"campaign_name":"Make Campaign","hidden":false,"visitors_count":0,"leads_count":0,"customers_count":0,"refunds_count":0,"cancellations_count":0,"sales_count":0,"sales_total":0,"refunds_total":0,"active_customers_count":0}]}]}},"exampleType":"generated"}},"exampleType":"generated"},"a6baafad-e335-45a6-9b73-257382b34f1e":{"description":"Authentication Error","content":{"application/json":{"schema":{"type":"string","example":"Bad credentials","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Bad credentials"}},"exampleType":"generated"}},"exampleType":"generated"},"5a1beb8c-7cf1-44c5-9dc0-93b4f54edcba":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"required":["error"],"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"example":{"error":"Campaign not found."},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Campaign not found."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"269911f4-0f00-42c0-8c6f-e9436c156c27":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"cf343685-35f1-4bf3-bc4e-8859f920d6d8":{"url":"https://firstpromoter.com/api/v1/promoters"}},"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/promoters-api/openapi-promoters.json"},"subdomain":"firstpromoter","siteName":"FirstPromoter Docs","title":"List promoters - FirstPromoter Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference-v2/api-admin/promoters/get-available-promoters","matchLevel":2},"v1":{"href":"/api-reference-v1/promoters-api/list","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T13:53:59.715Z","originalFileLocation":"api-reference-v1/promoters-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=\"List promoters, optionally for one campaign, with pagination in the response headers (legacy v1 API).\">\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 promoters - FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"List promoters, optionally for one campaign, with pagination in the response headers (legacy v1 API).\">\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/promoters-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=Promoters\u0026amp;title=List+promoters\u0026amp;description=List+promoters%2C+optionally+for+one+campaign%2C+with+pagination+in+the+response+headers+%28legacy+v1+API%29.\u0026amp;theme=fff9650e72028c28308bb6bc\u0026amp;signature=1066f206dfa9f0f34e8ffb57f583119f69069d478841b030a4f748ca5aa2c740\">\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 promoters - FirstPromoter Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List promoters, optionally for one campaign, with pagination in the response headers (legacy v1 API).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstpromoter.mintlify.site/_mintlify/api/og/v2?division=Promoters\u0026amp;title=List+promoters\u0026amp;description=List+promoters%2C+optionally+for+one+campaign%2C+with+pagination+in+the+response+headers+%28legacy+v1+API%29.\u0026amp;theme=fff9650e72028c28308bb6bc\u0026amp;signature=1066f206dfa9f0f34e8ffb57f583119f69069d478841b030a4f748ca5aa2c740\">\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/promoters-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/promoters-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/promoters-api/list#webpage\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/list\",\"name\":\"List promoters\",\"description\":\"List promoters, optionally for one campaign, with pagination in the response headers (legacy v1 API).\",\"dateModified\":\"2026-11-20T13:53:59.715Z\",\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Promoters\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List promoters\",\"item\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/list#apireference\",\"headline\":\"List promoters\",\"name\":\"List promoters\",\"description\":\"List promoters, optionally for one campaign, with pagination in the response headers (legacy v1 API).\",\"url\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v1/promoters-api/list#webpage\"},\"dateModified\":\"2026-11-20T13:53:59.715Z\",\"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/promoters-api/list.md","siteName":"FirstPromoter Docs","nav":{"global":null,"versions":[{"version":"v2","pages":[{"title":"v2","href":"/api-reference-v2/api-admin/promoters/get-available-promoters"}]},{"version":"v1","anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","boost":0.5,"pages":[{"title":"Introduction","href":"/api-reference-v1/introduction"},{"title":"Authentication","href":"/api-reference-v1/authentication"}]},{"group":"Tracking","boost":0.5,"pages":[{"title":"Tracking leads and sign-ups","openapi":"openapi-tracking POST /signup","href":"/api-reference-v1/tracking-api/leads-and-signups"},{"title":"Tracking subscribers","openapi":"openapi-tracking POST /subscriber","href":"/api-reference-v1/tracking-api/subscriber"},{"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","boost":0.5,"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","boost":0.5,"pages":[{"title":"Create a new promoter","openapi":"openapi-promoters POST /create","href":"/api-reference-v1/promoters-api/create"},{"title":"Modify existing promoter","description":"Update a promoter's profile, IDs or payout details, identified by id, email, cust_id, auth_token or ref_id (legacy v1 API).","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","description":"Get a promoter's details, identified by id, cust_id, auth_token, email or ref_id (legacy v1 API).","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","boost":0.5,"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","boost":0.5,"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","boost":0.5,"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 promoters - FirstPromoter Docs","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}