API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys
Custom fields for the promoter, based on company settings. This is a key-value pair object where keys are custom field identifiers and values are the corresponding data.
The team members this promoter is assigned to. Empty when nobody is assigned. Assignments are what an Affiliate Manager sees, so a manager only reads promoters that list them here.
Show child attributes
{"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.3966","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-v2/api-admin/promoters/get-promoter-details","slug":"/api-reference-v2/api-admin/promoters/get-promoter-details","pageMetadata":{"openapi":"openapi-v2-promoters get /promoters/{id}","title":"Get promoter details","description":"With this endpoint you can get the details of a promoter. \n \u003cTip>**HTTP Request** \u003cbr/>`GET https://api.firstpromoter.com/api/v2/company/promoters/{id}`\u003c/Tip>","href":"/api-reference-v2/api-admin/promoters/get-promoter-details"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n }, {Tip} = _components;\n if (!Tip) _missingMdxReference(\"Tip\", true);\n return _jsxs(_components.p, {\n children: [\"With this endpoint you can get the details of a promoter.\\n\", _jsxs(Tip, {\n children: [_jsx(_components.strong, {\n children: \"HTTP Request\"\n }), \" \", _jsx(\"br\", {}), _jsx(_components.code, {\n children: \"GET https://api.firstpromoter.com/api/v2/company/promoters/{id}\"\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":{"openapi":"openapi-v2-promoters get /promoters/{id}","title":"Get promoter details","description":"With this endpoint you can get the details of a promoter. \n \u003cTip>**HTTP Request** \u003cbr/>`GET https://api.firstpromoter.com/api/v2/company/promoters/{id}`\u003c/Tip>","href":"/api-reference-v2/api-admin/promoters/get-promoter-details"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstpromoter/8ad42af542d542c7/downloadables/fpr-prox.js"],"openApiReferenceData":{"operation":{"summary":"Get promoter details","description":"With this endpoint you can get the details of a promoter. \n \u003cTip>**HTTP Request** \u003cbr/>`GET https://api.firstpromoter.com/api/v2/company/promoters/{id}`\u003c/Tip>","operationId":"getPromoter","tags":["Promoters"],"parameters":["fda01500-2511-401c-8c6b-e5c37023e56e","822cedd9-f0dd-4c3e-b3bc-58a6bee34026","781ba186-d080-408c-97bc-af18b439e7f2"],"responses":{"200":"252c5c58-7d04-4616-8f9d-4a5922f0e7cc","401":"633b9bb5-85ad-4b0b-80f3-5ba75bca0129","403":"5cb5cb5f-20d5-4a15-beff-f745ea22c010","404":"f5af833b-3ec3-4034-9275-7c6a52b688a3","422":"01e2ee08-4fe0-45b5-b80c-4e5e35575379"},"method":"get","type":"path","servers":["ca59fc8c-15e5-4121-a53d-dbb3757de827"],"security":["379e167a-8059-427c-ac4d-525e422b308a"],"path":"/promoters/{id}","baseUrlOptions":["https://api.firstpromoter.com/api/v2/company"],"title":"Get promoter details","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fda01500-2511-401c-8c6b-e5c37023e56e":{"name":"Account-ID","in":"header","required":true,"description":"Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations","schema":{"type":"string","isRequired":true,"description":"Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations","uniqueKey":"","typeLabel":"string"}},"822cedd9-f0dd-4c3e-b3bc-58a6bee34026":{"name":"id","description":"The promoter's numeric ID, or the value of the attribute specified in `find_by` (e.g. an email address, auth token, ref token, promo code, or cust_id)","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The promoter's numeric ID, or the value of the attribute specified in `find_by` (e.g. an email address, auth token, ref token, promo code, or cust_id)","uniqueKey":"","typeLabel":"string"}},"781ba186-d080-408c-97bc-af18b439e7f2":{"name":"find_by","in":"query","description":"Find by attribute","schema":{"type":"string","enum":["email","cust_id","auth_token","ref_token","promo_code"],"description":"Find by attribute","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"252c5c58-7d04-4616-8f9d-4a5922f0e7cc":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the promoter","uniqueKey":"id","typeLabel":"integer"},"email":{"type":"string","description":"Email address of the promoter","uniqueKey":"email","typeLabel":"string"},"name":{"type":"string","description":"Full name of the promoter","uniqueKey":"name","typeLabel":"string"},"cust_id":{"oneOf":[{"type":"string","description":"Cust ID of the promoter","uniqueKey":"cust_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cust ID of the promoter","uniqueKey":"cust_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"cust_id","typeLabel":"string | null"},"note":{"oneOf":[{"type":"string","description":"Optional note about the promoter","uniqueKey":"note.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional note about the promoter","uniqueKey":"note.oneOf.1","typeLabel":"null"}],"uniqueKey":"note","typeLabel":"string | null"},"stats":{"type":"object","description":"Performance statistics for the promoter","properties":{"clicks_count":{"type":"integer","description":"Number of clicks generated","uniqueKey":"stats.clicks_count","typeLabel":"integer"},"referrals_count":{"type":"integer","description":"Number of referrals generated","uniqueKey":"stats.referrals_count","typeLabel":"integer"},"sales_count":{"type":"integer","description":"Number of sales generated","uniqueKey":"stats.sales_count","typeLabel":"integer"},"customers_count":{"type":"integer","description":"Number of customers referred","uniqueKey":"stats.customers_count","typeLabel":"integer"},"revenue_amount":{"type":"integer","description":"Total revenue generated","uniqueKey":"stats.revenue_amount","typeLabel":"integer"},"active_customers_count":{"type":"integer","description":"Number of active customers","uniqueKey":"stats.active_customers_count","typeLabel":"integer"}},"uniqueKey":"stats","typeLabel":"object"},"is_customized":{"type":"boolean","description":"Whether the promoter has customized settings","uniqueKey":"is_customized","typeLabel":"boolean"},"fraud_suspicions":{"type":"array","description":"List of potential fraud flags","items":{"type":"string","uniqueKey":"fraud_suspicions.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fraud_suspicions","typeLabel":"string[]"},"is_confirmed":{"type":"boolean","description":"Whether the promoter has confirmed their account","uniqueKey":"is_confirmed","typeLabel":"boolean"},"invoice_details_status":{"type":"string","description":"Status of the promoter's invoice details","enum":["pending","approved","denied"],"uniqueKey":"invoice_details_status","typeLabel":"enum\u003cstring>"},"profile":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the profile","uniqueKey":"profile.id","typeLabel":"integer"},"first_name":{"type":"string","description":"First name of the promoter","uniqueKey":"profile.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name of the promoter","uniqueKey":"profile.last_name","typeLabel":"string"},"website":{"oneOf":[{"type":"string","description":"Website of the promoter","uniqueKey":"profile.website.oneOf.0","typeLabel":"string"},{"type":"null","description":"Website of the promoter","uniqueKey":"profile.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.website","typeLabel":"string | null"},"company_name":{"oneOf":[{"type":"string","description":"Company name of the promoter","uniqueKey":"profile.company_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Company name of the promoter","uniqueKey":"profile.company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.company_name","typeLabel":"string | null"},"company_number":{"oneOf":[{"type":"string","description":"Company registration number","uniqueKey":"profile.company_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Company registration number","uniqueKey":"profile.company_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.company_number","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","description":"Phone number of the promoter","uniqueKey":"profile.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number of the promoter","uniqueKey":"profile.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.phone_number","typeLabel":"string | null"},"vat_id":{"oneOf":[{"type":"string","description":"VAT ID of the promoter","uniqueKey":"profile.vat_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"VAT ID of the promoter","uniqueKey":"profile.vat_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.vat_id","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Country in 2 characters format","example":"US","uniqueKey":"profile.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country in 2 characters format","example":"US","uniqueKey":"profile.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.country","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","description":"Address of the promoter","uniqueKey":"profile.address.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address of the promoter","uniqueKey":"profile.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.address","typeLabel":"string | null"},"avatar":{"type":"string","description":"URL to the promoter's avatar image","uniqueKey":"profile.avatar","typeLabel":"string"},"w8_form_url":{"oneOf":[{"type":"string","description":"URL to the promoter's W8 form if available","uniqueKey":"profile.w8_form_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to the promoter's W8 form if available","uniqueKey":"profile.w8_form_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.w8_form_url","typeLabel":"string | null"},"w9_form_url":{"oneOf":[{"type":"string","description":"URL to the promoter's W9 form if available","uniqueKey":"profile.w9_form_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to the promoter's W9 form if available","uniqueKey":"profile.w9_form_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.w9_form_url","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description of the promoter","uniqueKey":"profile.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description of the promoter","uniqueKey":"profile.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.description","typeLabel":"string | null"},"invoice_details_validation_errors":{"oneOf":[{"type":"object","description":"Validation errors for invoice details","uniqueKey":"profile.invoice_details_validation_errors.oneOf.0","typeLabel":"object"},{"type":"null","description":"Validation errors for invoice details","uniqueKey":"profile.invoice_details_validation_errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.invoice_details_validation_errors","typeLabel":"object | null"},"should_validate_invoice_details":{"type":"boolean","description":"Should validate invoice details","uniqueKey":"profile.should_validate_invoice_details","typeLabel":"boolean"},"instagram_url":{"oneOf":[{"type":"string","description":"Promoter's Instagram URL","uniqueKey":"profile.instagram_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Promoter's Instagram URL","uniqueKey":"profile.instagram_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.instagram_url","typeLabel":"string | null"},"youtube_url":{"oneOf":[{"type":"string","description":"Promoter's YouTube URL","uniqueKey":"profile.youtube_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Promoter's YouTube URL","uniqueKey":"profile.youtube_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.youtube_url","typeLabel":"string | null"},"linkedin_url":{"oneOf":[{"type":"string","description":"Promoter's LinkedIn URL","uniqueKey":"profile.linkedin_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Promoter's LinkedIn URL","uniqueKey":"profile.linkedin_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.linkedin_url","typeLabel":"string | null"},"facebook_url":{"oneOf":[{"type":"string","description":"Promoter's Facebook URL","uniqueKey":"profile.facebook_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Promoter's Facebook URL","uniqueKey":"profile.facebook_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.facebook_url","typeLabel":"string | null"},"twitter_url":{"oneOf":[{"type":"string","description":"Promoter's Twitter URL","uniqueKey":"profile.twitter_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Promoter's Twitter URL","uniqueKey":"profile.twitter_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.twitter_url","typeLabel":"string | null"},"twitch_url":{"oneOf":[{"type":"string","description":"Promoter's Twitch URL","uniqueKey":"profile.twitch_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Promoter's Twitch URL","uniqueKey":"profile.twitch_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.twitch_url","typeLabel":"string | null"},"tiktok_url":{"oneOf":[{"type":"string","description":"Promoter's TikTok URL","uniqueKey":"profile.tiktok_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Promoter's TikTok URL","uniqueKey":"profile.tiktok_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile.tiktok_url","typeLabel":"string | null"}},"uniqueKey":"profile","typeLabel":"object"},"joined_at":{"type":"string","format":"date-time","description":"Date and time when the promoter joined.","uniqueKey":"joined_at","typeLabel":"string\u003cdate-time>"},"last_login_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date and time of the promoter's last login.","uniqueKey":"last_login_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date and time of the promoter's last login.","uniqueKey":"last_login_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_login_at","typeLabel":"string\u003cdate-time> | null"},"archived_at":{"oneOf":[{"type":"string","format":"date-time","description":"Date and time when the promoter was archived, if applicable.","uniqueKey":"archived_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date and time when the promoter was archived, if applicable.","uniqueKey":"archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"archived_at","typeLabel":"string\u003cdate-time> | null"},"custom_fields":{"oneOf":[{"type":"object","description":"Custom fields for the promoter, based on company settings. This is a key-value pair object where keys are custom field identifiers and values are the corresponding data.","uniqueKey":"custom_fields.oneOf.0","typeLabel":"object"},{"type":"null","description":"Custom fields for the promoter, based on company settings. This is a key-value pair object where keys are custom field identifiers and values are the corresponding data.","uniqueKey":"custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields","typeLabel":"object | null"},"password_setup_url":{"oneOf":[{"type":"string","description":"URL for the promoter to set up their password","uniqueKey":"password_setup_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL for the promoter to set up their password","uniqueKey":"password_setup_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"password_setup_url","typeLabel":"string | null"},"first_event_at":{"type":"string","format":"date-time","description":"Date and time of the promoter's first activity.","uniqueKey":"first_event_at","typeLabel":"string\u003cdate-time>"},"promoter_campaigns":{"type":"array","description":"List of campaigns associated with the promoter","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the promoter-campaign association","uniqueKey":"promoter_campaigns.items.[INDEX].id","typeLabel":"integer"},"campaign_id":{"type":"integer","description":"ID of the campaign","uniqueKey":"promoter_campaigns.items.[INDEX].campaign_id","typeLabel":"integer"},"promoter_id":{"type":"integer","description":"ID of the promoter","uniqueKey":"promoter_campaigns.items.[INDEX].promoter_id","typeLabel":"integer"},"state":{"type":"string","description":"State of the promoter in this campaign","enum":["pending","accepted","rejected","blocked","inactive","not_set"],"uniqueKey":"promoter_campaigns.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"When the promoter was added to the campaign","uniqueKey":"promoter_campaigns.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"campaign":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the campaign","uniqueKey":"promoter_campaigns.items.[INDEX].campaign.id","typeLabel":"integer"},"name":{"type":"string","description":"Name of the campaign","uniqueKey":"promoter_campaigns.items.[INDEX].campaign.name","typeLabel":"string"},"color":{"type":"string","description":"Color code associated with the campaign","uniqueKey":"promoter_campaigns.items.[INDEX].campaign.color","typeLabel":"string"}},"uniqueKey":"promoter_campaigns.items.[INDEX].campaign","typeLabel":"object"},"coupon":{"type":"string","description":"Coupon code for this campaign","uniqueKey":"promoter_campaigns.items.[INDEX].coupon","typeLabel":"string"},"ref_token":{"type":"string","description":"Referral token for this campaign","uniqueKey":"promoter_campaigns.items.[INDEX].ref_token","typeLabel":"string"},"ref_link":{"type":"string","description":"Referral link for this campaign","uniqueKey":"promoter_campaigns.items.[INDEX].ref_link","typeLabel":"string"}},"uniqueKey":"promoter_campaigns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"promoter_campaigns","typeLabel":"object[]"},"balances":{"type":"object","description":"Earnings balance breakdown for the promoter","properties":{"cash":{"oneOf":[{"type":"number","uniqueKey":"balances.cash.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"balances.cash.oneOf.1","typeLabel":"null"}],"uniqueKey":"balances.cash","typeLabel":"number | null"},"credits":{"oneOf":[{"type":"number","uniqueKey":"balances.credits.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"balances.credits.oneOf.1","typeLabel":"null"}],"uniqueKey":"balances.credits","typeLabel":"number | null"},"points":{"oneOf":[{"type":"number","uniqueKey":"balances.points.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"balances.points.oneOf.1","typeLabel":"null"}],"uniqueKey":"balances.points","typeLabel":"number | null"},"free_months":{"oneOf":[{"type":"number","uniqueKey":"balances.free_months.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"balances.free_months.oneOf.1","typeLabel":"null"}],"uniqueKey":"balances.free_months","typeLabel":"number | null"},"discount":{"oneOf":[{"type":"number","uniqueKey":"balances.discount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"balances.discount.oneOf.1","typeLabel":"null"}],"uniqueKey":"balances.discount","typeLabel":"number | null"}},"uniqueKey":"balances","typeLabel":"object"},"track_ad_traffic":{"oneOf":[{"type":"boolean","description":"Whether ad traffic tracking is enabled for this promoter. Null means the campaign default is used.","uniqueKey":"track_ad_traffic.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether ad traffic tracking is enabled for this promoter. Null means the campaign default is used.","uniqueKey":"track_ad_traffic.oneOf.1","typeLabel":"null"}],"uniqueKey":"track_ad_traffic","typeLabel":"boolean | null"},"auth_provider":{"oneOf":[{"type":"string","description":"OAuth provider used to authenticate (e.g. google). Null if using email/password.","uniqueKey":"auth_provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"OAuth provider used to authenticate (e.g. google). Null if using email/password.","uniqueKey":"auth_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"auth_provider","typeLabel":"string | null"},"selected_payout_method":{"oneOf":[{"type":"object","description":"The promoter's currently selected payout method. Omitted when the `exclude_payout_method=true` query parameter is set.","properties":{"id":{"type":"integer","uniqueKey":"selected_payout_method.oneOf.0.id","typeLabel":"integer"},"method":{"type":"string","uniqueKey":"selected_payout_method.oneOf.0.method","typeLabel":"string"},"date_added":{"type":"string","format":"date-time","uniqueKey":"selected_payout_method.oneOf.0.date_added","typeLabel":"string\u003cdate-time>"},"is_disabled":{"type":"boolean","uniqueKey":"selected_payout_method.oneOf.0.is_disabled","typeLabel":"boolean"}},"uniqueKey":"selected_payout_method.oneOf.0","typeLabel":"object"},{"type":"null","description":"The promoter's currently selected payout method. Omitted when the `exclude_payout_method=true` query parameter is set.","properties":{"id":{"type":"integer"},"method":{"type":"string"},"date_added":{"type":"string","format":"date-time"},"is_disabled":{"type":"boolean"}},"uniqueKey":"selected_payout_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"selected_payout_method","typeLabel":"object | null"},"parent_promoter":{"oneOf":[{"type":"object","description":"The parent promoter (for sub-affiliate relationships). Only included when the `include_parent_promoter=true` query parameter is set.","properties":{"id":{"type":"integer","uniqueKey":"parent_promoter.oneOf.0.id","typeLabel":"integer"},"email":{"type":"string","uniqueKey":"parent_promoter.oneOf.0.email","typeLabel":"string"},"name":{"oneOf":[{"type":"string","uniqueKey":"parent_promoter.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"parent_promoter.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_promoter.oneOf.0.name","typeLabel":"string | null"}},"uniqueKey":"parent_promoter.oneOf.0","typeLabel":"object"},{"type":"null","description":"The parent promoter (for sub-affiliate relationships). Only included when the `include_parent_promoter=true` query parameter is set.","properties":{"id":{"type":"integer"},"email":{"type":"string"},"name":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"parent_promoter.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_promoter","typeLabel":"object | null"},"assigned_to":{"type":"array","description":"The team members this promoter is assigned to. Empty when nobody is assigned. Assignments are what an Affiliate Manager sees, so a manager only reads promoters that list them here.","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the team member (company user), which is also what the `assigned_to` filter takes","uniqueKey":"assigned_to.items.[INDEX].id","typeLabel":"integer"},"name":{"oneOf":[{"type":"string","uniqueKey":"assigned_to.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"assigned_to.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"assigned_to.items.[INDEX].name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"assigned_to.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"assigned_to.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"uniqueKey":"assigned_to.items.[INDEX].email","typeLabel":"string | null"}},"uniqueKey":"assigned_to.items.[INDEX]","typeLabel":"object"},"uniqueKey":"assigned_to","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"email":"\u003cstring>","name":"\u003cstring>","cust_id":"\u003cstring>","note":"\u003cstring>","stats":{"clicks_count":123,"referrals_count":123,"sales_count":123,"customers_count":123,"revenue_amount":123,"active_customers_count":123},"is_customized":true,"fraud_suspicions":["\u003cstring>"],"is_confirmed":true,"invoice_details_status":"pending","profile":{"id":123,"first_name":"\u003cstring>","last_name":"\u003cstring>","website":"\u003cstring>","company_name":"\u003cstring>","company_number":"\u003cstring>","phone_number":"\u003cstring>","vat_id":"\u003cstring>","country":"US","address":"\u003cstring>","avatar":"\u003cstring>","w8_form_url":"\u003cstring>","w9_form_url":"\u003cstring>","description":"\u003cstring>","invoice_details_validation_errors":{},"should_validate_invoice_details":true,"instagram_url":"\u003cstring>","youtube_url":"\u003cstring>","linkedin_url":"\u003cstring>","facebook_url":"\u003cstring>","twitter_url":"\u003cstring>","twitch_url":"\u003cstring>","tiktok_url":"\u003cstring>"},"joined_at":"2023-11-07T05:31:56Z","last_login_at":"2023-11-07T05:31:56Z","archived_at":"2023-11-07T05:31:56Z","custom_fields":{},"password_setup_url":"\u003cstring>","first_event_at":"2023-11-07T05:31:56Z","promoter_campaigns":[{"id":123,"campaign_id":123,"promoter_id":123,"state":"pending","created_at":"2023-11-07T05:31:56Z","campaign":{"id":123,"name":"\u003cstring>","color":"\u003cstring>"},"coupon":"\u003cstring>","ref_token":"\u003cstring>","ref_link":"\u003cstring>"}],"balances":{"cash":123,"credits":123,"points":123,"free_months":123,"discount":123},"track_ad_traffic":true,"auth_provider":"\u003cstring>","selected_payout_method":{"id":123,"method":"\u003cstring>","date_added":"2023-11-07T05:31:56Z","is_disabled":true},"parent_promoter":{"id":123,"email":"\u003cstring>","name":"\u003cstring>"},"assigned_to":[{"id":123,"name":"\u003cstring>","email":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"633b9bb5-85ad-4b0b-80f3-5ba75bca0129":{"description":"Unauthorized — the Bearer access token is missing, invalid, expired, or revoked. No JSON response body is returned.","content":{"application/json":{"schema":{"type":"object","uniqueKey":"","typeLabel":"object"},"example":{},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"examples"}},"exampleType":"examples"},"5cb5cb5f-20d5-4a15-beff-f745ea22c010":{"description":"Forbidden — the authenticated user does not have permission to perform this action","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"You don't have enough rights to perform this action","code":"forbidden"},"examples":{"Example":{"title":"Example","value":{"message":"You don't have enough rights to perform this action","code":"forbidden"}}},"exampleType":"examples"}},"exampleType":"examples"},"f5af833b-3ec3-4034-9275-7c6a52b688a3":{"description":"Promoter not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Record not found","code":"not_found"},"examples":{"Example":{"title":"Example","value":{"message":"Record not found","code":"not_found"}}},"exampleType":"examples"}},"exampleType":"examples"},"01e2ee08-4fe0-45b5-b80c-4e5e35575379":{"description":"Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Cannot find promoter by email","code":"invalid_params"},"examples":{"Example":{"title":"Example","value":{"message":"Cannot find promoter by email","code":"invalid_params"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"379e167a-8059-427c-ac4d-525e422b308a":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"ca59fc8c-15e5-4121-a53d-dbb3757de827":{"url":"https://api.firstpromoter.com/api/v2/company"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference-v2/api-admin/promoters/openapi-v2-promoters.json"},"subdomain":"firstpromoter","siteName":"FirstPromoter Docs","title":"Get promoter details - FirstPromoter Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference-v2/api-admin/promoters/get-promoter-details","matchLevel":0},"v1":{"href":"/api-reference-v1/promoters-api/create","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2025-09-24T16:23:41.369Z","originalFileLocation":"api-reference-v2/api-admin/promoters/get-promoter-details.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 get the details of a promoter. HTTP Request GET https://api.firstpromoter.com/api/v2/company/promoters/{id}\">\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=\"Get promoter details - FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"With this endpoint you can get the details of a promoter. HTTP Request GET https://api.firstpromoter.com/api/v2/company/promoters/{id}\">\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-v2/api-admin/promoters/get-promoter-details\">\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=Promoters\u0026amp;title=Get+promoter+details\u0026amp;description=With+this+endpoint+you+can+get+the+details+of+a+promoter.+%0A+%3CTip%3E**HTTP+Request**+%3Cbr%2F%3E%60GET+https%3A%2F%2Fapi.firstpromoter.com%2Fapi%2Fv2%2Fcompany%2Fpromoters%2F%7Bid%7D%60%3C%2FTip%3E\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=e921ecaf99eefcb245181c919fa5b574130fa675033a33ea90d7f6ad5331ea16\">\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=\"Get promoter details - FirstPromoter Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"With this endpoint you can get the details of a promoter. HTTP Request GET https://api.firstpromoter.com/api/v2/company/promoters/{id}\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstpromoter.mintlify.app/_mintlify/api/og/v2?division=Promoters\u0026amp;title=Get+promoter+details\u0026amp;description=With+this+endpoint+you+can+get+the+details+of+a+promoter.+%0A+%3CTip%3E**HTTP+Request**+%3Cbr%2F%3E%60GET+https%3A%2F%2Fapi.firstpromoter.com%2Fapi%2Fv2%2Fcompany%2Fpromoters%2F%7Bid%7D%60%3C%2FTip%3E\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=e921ecaf99eefcb245181c919fa5b574130fa675033a33ea90d7f6ad5331ea16\">\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-v2/api-admin/promoters/get-promoter-details\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference-v2/api-admin/promoters/get-promoter-details.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-v2/api-admin/promoters/get-promoter-details#webpage\",\"url\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/promoters/get-promoter-details\",\"name\":\"Get promoter details\",\"description\":\"With this endpoint you can get the details of a promoter. HTTP Request GET https://api.firstpromoter.com/api/v2/company/promoters/{id}\",\"dateModified\":\"2025-09-24T16:23:41.369Z\",\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/promoters/get-promoter-details#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/promoters/get-promoter-details#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Promoters\",\"item\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/promoters/get-available-promoters\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get promoter details\",\"item\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/promoters/get-promoter-details\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/promoters/get-promoter-details#apireference\",\"headline\":\"Get promoter details\",\"name\":\"Get promoter details\",\"description\":\"With this endpoint you can get the details of a promoter. HTTP Request GET https://api.firstpromoter.com/api/v2/company/promoters/{id}\",\"url\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/promoters/get-promoter-details\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/promoters/get-promoter-details#webpage\"},\"dateModified\":\"2025-09-24T16:23:41.369Z\",\"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","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-v2/api-admin/introduction"},{"title":"Authentication","href":"/api-reference-v2/api-admin/authentication"}]},{"group":"Batch Processes","pages":[{"openapi":"openapi-v2-batches get /batch_processes","title":"List in progress batch processes.","href":"/api-reference-v2/api-admin/batches/list-inprogress-batch-processes"},{"openapi":"openapi-v2-batches get /batch_processes/{id}","title":"Show batch process","href":"/api-reference-v2/api-admin/batches/show-batch-process"},{"openapi":"openapi-v2-batches get /batch_processes/progress","title":"Show progress","href":"/api-reference-v2/api-admin/batches/show-progress"}]},{"group":"Tracking Api","pages":[{"title":"Tracking leads and sign-ups","openapi":"openapi-v2-tracking POST /signup","href":"/api-reference-v2/api-admin/tracking-api/leads-and-signups"},{"title":"Tracking sales and commissions","openapi":"openapi-v2-tracking POST /sale","href":"/api-reference-v2/api-admin/tracking-api/sales"},{"title":"Tracking refunds and negative commissions","openapi":"openapi-v2-tracking POST /refund","href":"/api-reference-v2/api-admin/tracking-api/refund"},{"title":"Tracking cancellations","openapi":"openapi-v2-tracking POST /cancellation","href":"/api-reference-v2/api-admin/tracking-api/cancellation"}]},{"group":"Referrals","pages":[{"openapi":"openapi-v2-referrals get /referrals","title":"Get available referrals","href":"/api-reference-v2/api-admin/referrals/get-referrals"},{"openapi":"openapi-v2-referrals get /referrals/{id}","title":"Get referral","href":"/api-reference-v2/api-admin/referrals/get-referral"},{"openapi":"openapi-v2-referrals put /referrals/{id}","title":"Update referral","href":"/api-reference-v2/api-admin/referrals/update-referral"},{"openapi":"openapi-v2-referrals post /referrals/move_to_promoter","title":"Move referrals to promoter","href":"/api-reference-v2/api-admin/referrals/move-referrals-to-promoter"},{"openapi":"openapi-v2-referrals delete /referrals","title":"Delete referrals","href":"/api-reference-v2/api-admin/referrals/delete-referrals"}]},{"group":"Promoters","pages":[{"openapi":"openapi-v2-promoters get /promoters","title":"Get available promoters","href":"/api-reference-v2/api-admin/promoters/get-available-promoters"},{"openapi":"openapi-v2-promoters post /promoters","title":"Create promoter","description":"With this endpoint you can create a promoter. \n \u003cTip>**HTTP Request** \u003cbr/>`POST https://api.firstpromoter.com/api/v2/company/promoters`\u003c/Tip>","href":"/api-reference-v2/api-admin/promoters/create-promoter"},{"openapi":"openapi-v2-promoters get /promoters/{id}","title":"Get promoter details","href":"/api-reference-v2/api-admin/promoters/get-promoter-details"},{"openapi":"openapi-v2-promoters put /promoters/{id}","title":"Update promoter","description":"With this endpoint you can update a promoter. \n \u003cTip>**HTTP Request** \u003cbr/>`PUT https://api.firstpromoter.com/api/v2/company/promoters/{id}`\u003c/Tip>","href":"/api-reference-v2/api-admin/promoters/update-promoter"},{"openapi":"openapi-v2-promoters get /promoters/{id}/referral_links","title":"Get promoter referral links","href":"/api-reference-v2/api-admin/promoters/get-promoter-referral-links"},{"openapi":"openapi-v2-promoters get /promoters/{id}/chart_data","title":"Get data used for chart","href":"/api-reference-v2/api-admin/promoters/get-data-used-for-chart"},{"openapi":"openapi-v2-promoters get /promoters/{id}/overview_report","title":"Get reports for promoter overview","href":"/api-reference-v2/api-admin/promoters/get-reports-for-promoter-overview"},{"openapi":"openapi-v2-promoters get /promoters/{id}/traffic_sources_report","title":"Get reports for promoter traffic sources","href":"/api-reference-v2/api-admin/promoters/get-reports-for-promoter-traffic-sources"},{"openapi":"openapi-v2-promoters get /promoters/{id}/urls_report","title":"Get reports for promoter URLs","href":"/api-reference-v2/api-admin/promoters/get-reports-for-promoter-urls"},{"openapi":"openapi-v2-promoters post /promoters/assign_parent","title":"Assign a parent promoter","href":"/api-reference-v2/api-admin/promoters/assign-parent-promoter"},{"openapi":"openapi-v2-promoters post /promoters/add_to_campaign","title":"Add promoters to campaign","href":"/api-reference-v2/api-admin/promoters/add-promoter-to-campaign"},{"openapi":"openapi-v2-promoters post /promoters/move_to_campaign","title":"Move promoters to campaign","href":"/api-reference-v2/api-admin/promoters/move-promoter-to-campaign"},{"openapi":"openapi-v2-promoters post /promoters/accept","title":"Accept promoters","href":"/api-reference-v2/api-admin/promoters/accept-promoters"},{"openapi":"openapi-v2-promoters post /promoters/reject","title":"Reject promoters","href":"/api-reference-v2/api-admin/promoters/reject-promoters"},{"openapi":"openapi-v2-promoters post /promoters/block","title":"Block promoters","href":"/api-reference-v2/api-admin/promoters/block-promoters"},{"openapi":"openapi-v2-promoters post /promoters/archive","title":"Archive promoters","href":"/api-reference-v2/api-admin/promoters/archive-promoters"},{"openapi":"openapi-v2-promoters post /promoters/restore","title":"Restore promoters","href":"/api-reference-v2/api-admin/promoters/restore-unarchived-promoters"}]},{"group":"Promoter Campaigns","pages":[{"openapi":"openapi-v2-promoter-campaigns get /promoter_campaigns","title":"Get available promoter campaigns","href":"/api-reference-v2/api-admin/promoter-campaigns/get-available-promoter-campaigns"},{"openapi":"openapi-v2-promoter-campaigns put /promoter_campaigns/{id}","title":"Update promoter campaign","href":"/api-reference-v2/api-admin/promoter-campaigns/update-promoter-campaign"}]},{"group":"Commissions","pages":[{"openapi":"openapi-v2-commissions get /commissions","title":"Get all commissions","href":"/api-reference-v2/api-admin/commissions/get-all-commissions"},{"openapi":"openapi-v2-commissions post /commissions","title":"Create a commission","href":"/api-reference-v2/api-admin/commissions/create-a-commission"},{"openapi":"openapi-v2-commissions put /commissions/{id}","title":"Update a commission","href":"/api-reference-v2/api-admin/commissions/update-a-commission"},{"openapi":"openapi-v2-commissions post /commissions/approve","title":"Approve commissions","href":"/api-reference-v2/api-admin/commissions/approve-commissions"},{"openapi":"openapi-v2-commissions post /commissions/deny","title":"Deny commissions","href":"/api-reference-v2/api-admin/commissions/deny-commissions"},{"openapi":"openapi-v2-commissions post /commissions/mark_fulfilled","title":"Mark nonmonetary commissions as fulfilled","href":"/api-reference-v2/api-admin/commissions/mark-nonmonetary-commissions-as-fulfilled"},{"openapi":"openapi-v2-commissions post /commissions/mark_unfulfilled","title":"Mark nonmonetary commissions as unfulfilled","href":"/api-reference-v2/api-admin/commissions/mark-nonmonetary-commissions-as-unfulfilled"}]},{"group":"Promo Codes","pages":[{"openapi":"openapi-v2-promocodes get /promo_codes","title":"Get promo codes","href":"/api-reference-v2/api-admin/promo-codes/get-promo-codes"},{"openapi":"openapi-v2-promocodes get /promo_codes/{id}","title":"Get promo code by id","href":"/api-reference-v2/api-admin/promo-codes/get-promo-code-by-id"},{"openapi":"openapi-v2-promocodes post /promo_codes","title":"Create promo code (Stripe Only)","href":"/api-reference-v2/api-admin/promo-codes/create-promo-code"},{"openapi":"openapi-v2-promocodes put /promo_codes/{id}","title":"Update promo code by id","href":"/api-reference-v2/api-admin/promo-codes/update-promo-code-by-id"},{"openapi":"openapi-v2-promocodes delete /promo_codes/{id}","title":"Archive promo code by id","href":"/api-reference-v2/api-admin/promo-codes/archive-promo-code-by-id"}]},{"group":"Payouts","pages":[{"openapi":"openapi-v2-payouts get /payouts","title":"Get all payouts","href":"/api-reference-v2/api-admin/payouts/get-all-payouts"},{"openapi":"openapi-v2-payouts get /payouts/stats","title":"Get payout stats","href":"/api-reference-v2/api-admin/payouts/get-payout-stats"},{"openapi":"openapi-v2-payouts get /payouts/due_stats","title":"Get due payout stats","href":"/api-reference-v2/api-admin/payouts/get-due-payout-stats"},{"openapi":"openapi-v2-payouts get /payouts/group_by_promoters","title":"Get all payouts grouped by promoters","href":"/api-reference-v2/api-admin/payouts/get-all-payouts-grouped-by-promoters"}]},{"group":"Reports","pages":[{"openapi":"openapi-v2-reports get /reports/campaigns","title":"Get reports for campaigns","href":"/api-reference-v2/api-admin/reports/get-reports-for-campaigns"},{"openapi":"openapi-v2-reports get /reports/overview","title":"Get reports for overview","href":"/api-reference-v2/api-admin/reports/get-reports-for-overview"},{"openapi":"openapi-v2-reports get /reports/promoters","title":"Get reports for promoters","href":"/api-reference-v2/api-admin/reports/get-reports-for-promoters"},{"openapi":"openapi-v2-reports get /reports/urls","title":"Get reports for URLs","href":"/api-reference-v2/api-admin/reports/get-reports-for-urls"},{"openapi":"openapi-v2-reports get /reports/traffic_sources","title":"Get reports for traffic sources","href":"/api-reference-v2/api-admin/reports/get-reports-for-traffic-sources"}]}]},{"tab":"Affiliate API Reference","hidden":true,"pages":[{"title":"Affiliate API Reference","href":"/api-reference-v2/api-affiliate/introduction"}]},{"tab":"Advanced API Reference","hidden":true,"pages":[{"title":"Advanced API Reference","href":"/api-reference-v2/api-advanced/introduction"}]}]},{"anchor":"API Reference","icon":"webhook","href":"https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction"},{"anchor":"Help Center","icon":"square-question","href":"https://help.firstpromoter.com/en/"}]},{"version":"v1","pages":[{"title":"v1","href":"/api-reference-v1/promoters-api/create"}]}]},"title":"Get promoter details - FirstPromoter Docs","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}