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 → Manage API Keys
Entry source of the referral. This shows where the referral was captured from.
Cookie is set if the referral was captured using the tid cookie,
Coupon is for when the referral is captured via a coupon code.
Manual admin is for when the referral is added manually by an admin.
Manual affiliate is for when the referral is added manually by an affiliate.
Fraud check (suspicion) status of the referral. no_suspicion means the referral is clean or was manually cleared. same_ip_suspicion means the referral shares an IP with the promoter. same_promoter_email means the referral email matches the promoter email. ad_source means the referral arrived via a paid ad click.
The commission split configuration for this referral. Each entry represents a split partner. The primary promoter (the referral owner) receives the remainder of the commission after all split percentages are applied.
{"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":"6aeb056486e5c4288ac4ca44","collectionId":"46b1f99c-db41-4d10-8d3e-8d7eeeaa0b5e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb056486e5c4288ac4ca44"},"entitlements":{},"buildId":"6aeb056486e5c4288ac4ca44","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Documentation","count":213},{"language":"default","tag":"API Reference","count":81},{"language":"default","tag":"Integration Options","count":41},{"language":"default","tag":"Promoters","count":25},{"language":"default","tag":"Platform","count":23},{"language":"default","tag":"Custom","count":9},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Reports","count":8},{"language":"default","tag":"Payouts","count":7},{"language":"default","tag":"Commissions","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference-v2/api-admin/referrals/get-referrals","slug":"/api-reference-v2/api-admin/referrals/get-referrals","pageMetadata":{"openapi":"openapi-v2-referrals get /referrals","title":"Get available referrals","description":"Get available referrals \n \u003cTip>**HTTP Request** \u003cbr/>`GET https://api.firstpromoter.com/api/v2/company/referrals`\u003c/Tip>","href":"/api-reference-v2/api-admin/referrals/get-referrals"},"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: [\"Get available referrals\\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/referrals\"\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-referrals get /referrals","title":"Get available referrals","description":"Get available referrals \n \u003cTip>**HTTP Request** \u003cbr/>`GET https://api.firstpromoter.com/api/v2/company/referrals`\u003c/Tip>","href":"/api-reference-v2/api-admin/referrals/get-referrals"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firstpromoter/8ad42af542d542c7/downloadables/fpr-prox.js"],"openApiReferenceData":{"operation":{"summary":"Get available referrals","tags":["Referrals"],"description":"Get available referrals \n \u003cTip>**HTTP Request** \u003cbr/>`GET https://api.firstpromoter.com/api/v2/company/referrals`\u003c/Tip>","parameters":["01c06572-a550-44e8-a9d6-bb6b7640c005","f16a5a47-03e8-491d-968f-0c80edcfb40c","0caa20a7-f8b2-41f2-9e5f-bc5b2fa19041","fcfec8ee-b529-40fb-bbc7-55fe59c3dc30","7d7484e9-157a-4469-b38c-9e124e781231","577cae5d-1e30-4088-8ef3-44ea366984eb","85083197-aadc-458c-903a-00af84105c48","63966a94-cd4f-4373-8e06-fa6aa254da00","ca5607f1-5b1a-4f4a-aece-9a3c4b2a5d64","64a7c34a-e910-4b4e-ad31-f42bace72574","50f51958-99c4-4d7b-82c6-2023710c17ab","bec9aa89-aaa0-4927-b15b-8c208d6ff963"],"responses":{"200":"ae620b72-1976-4615-847e-46300731e080","401":"f4282ccb-3c01-4683-82a1-5b571643da18","403":"50e35bb9-9a2e-4bd9-b674-80a7705b9277"},"method":"get","type":"path","servers":["ac87d9a9-9c04-4105-b282-5a8446996153"],"security":["d11ac46b-5fd2-43c8-baa4-9088fb1b82a5"],"path":"/referrals","baseUrlOptions":["https://api.firstpromoter.com/api/v2/company"],"title":"Get available referrals","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"01c06572-a550-44e8-a9d6-bb6b7640c005":{"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"}},"f16a5a47-03e8-491d-968f-0c80edcfb40c":{"in":"query","name":"q","schema":{"type":"string","description":"Search params. Searches by email, uid, username, website","uniqueKey":"","typeLabel":"string"},"description":"Search params. Searches by email, uid, username, website"},"0caa20a7-f8b2-41f2-9e5f-bc5b2fa19041":{"name":"ids[]","in":"query","description":"Array of referral ids to get","required":false,"schema":{"type":"array","items":{"type":"integer","uniqueKey":"items.[INDEX]","typeLabel":"integer"},"isRequired":false,"description":"Array of referral ids to get","uniqueKey":"","typeLabel":"integer[]"}},"fcfec8ee-b529-40fb-bbc7-55fe59c3dc30":{"in":"query","name":"filters[type]","schema":{"type":"string","enum":["lead","customer"],"description":"Filter the referrals by type (lead or customer)","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Filter the referrals by type (lead or customer)"},"7d7484e9-157a-4469-b38c-9e124e781231":{"in":"query","name":"filters[promoter_id]","schema":{"type":"string","description":"Filter the referrals by a promoter id","uniqueKey":"","typeLabel":"string"},"description":"Filter the referrals by a promoter id"},"577cae5d-1e30-4088-8ef3-44ea366984eb":{"in":"query","name":"filters[state]","schema":{"type":"string","enum":["subscribed","signup","active","cancelled","refunded","denied","pending","moved"],"description":"Filter the referrals by state","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Filter the referrals by state"},"85083197-aadc-458c-903a-00af84105c48":{"in":"query","name":"filters[customer_since][from]","schema":{"type":"string","format":"date","description":"Filter referrals where customer_since is on or after this date (ISO 8601 format: YYYY-MM-DD)","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Filter referrals where customer_since is on or after this date (ISO 8601 format: YYYY-MM-DD)"},"63966a94-cd4f-4373-8e06-fa6aa254da00":{"in":"query","name":"filters[customer_since][to]","schema":{"type":"string","format":"date","description":"Filter referrals where customer_since is on or before this date (ISO 8601 format: YYYY-MM-DD)","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Filter referrals where customer_since is on or before this date (ISO 8601 format: YYYY-MM-DD)"},"ca5607f1-5b1a-4f4a-aece-9a3c4b2a5d64":{"in":"query","name":"filters[created_at][from]","schema":{"type":"string","format":"date","description":"Filter referrals created on or after this date (ISO 8601 format: YYYY-MM-DD)","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Filter referrals created on or after this date (ISO 8601 format: YYYY-MM-DD)"},"64a7c34a-e910-4b4e-ad31-f42bace72574":{"in":"query","name":"filters[created_at][to]","schema":{"type":"string","format":"date","description":"Filter referrals created on or before this date (ISO 8601 format: YYYY-MM-DD)","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Filter referrals created on or before this date (ISO 8601 format: YYYY-MM-DD)"},"50f51958-99c4-4d7b-82c6-2023710c17ab":{"in":"query","name":"filters[cancelled_at][from]","schema":{"type":"string","format":"date","description":"Filter referrals cancelled on or after this date (ISO 8601 format: YYYY-MM-DD)","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Filter referrals cancelled on or after this date (ISO 8601 format: YYYY-MM-DD)"},"bec9aa89-aaa0-4927-b15b-8c208d6ff963":{"in":"query","name":"filters[cancelled_at][to]","schema":{"type":"string","format":"date","description":"Filter referrals cancelled on or before this date (ISO 8601 format: YYYY-MM-DD)","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Filter referrals cancelled on or before this date (ISO 8601 format: YYYY-MM-DD)"}},"responses":{"ae620b72-1976-4615-847e-46300731e080":{"description":"List of referrals","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the referral","uniqueKey":"items.[INDEX].id","typeLabel":"integer"},"email":{"type":"string","format":"email","description":"Email address of the referral","uniqueKey":"items.[INDEX].email","typeLabel":"string\u003cemail>"},"uid":{"type":"string","description":"uid of the referral","uniqueKey":"items.[INDEX].uid","typeLabel":"string"},"state":{"type":"string","enum":["subscribed","signup","active","cancelled","refunded","denied","pending","moved"],"description":"State of the referral","uniqueKey":"items.[INDEX].state","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"Additional metadata of the referral","uniqueKey":"items.[INDEX].metadata","typeLabel":"object"},"entry_source":{"type":"string","enum":["api","coupon","cookie","manual_admin","manual_affiliate"],"description":"Entry source of the referral. This shows where the referral was captured from. \n **Cookie** is set if the referral was captured using the tid cookie, \n **Coupon** is for when the referral is captured via a coupon code. \n**Manual admin** is for when the referral is added manually by an admin. \n**Manual affiliate** is for when the referral is added manually by an affiliate.","uniqueKey":"items.[INDEX].entry_source","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"Date and time when the referral was created","uniqueKey":"items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"customer_since":{"oneOf":[{"type":"string","format":"date-time","description":"Date and time when the referral became a customer","uniqueKey":"items.[INDEX].customer_since.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date and time when the referral became a customer","uniqueKey":"items.[INDEX].customer_since.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].customer_since","typeLabel":"string\u003cdate-time> | null"},"promoter_campaign":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the promoter campaign","uniqueKey":"items.[INDEX].promoter_campaign.id","typeLabel":"integer"},"campaign_id":{"type":"integer","description":"Id of the campaign","uniqueKey":"items.[INDEX].promoter_campaign.campaign_id","typeLabel":"integer"},"promoter_id":{"type":"integer","description":"Id of the promoter","uniqueKey":"items.[INDEX].promoter_campaign.promoter_id","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","description":"Date and time when the promoter campaign was created","uniqueKey":"items.[INDEX].promoter_campaign.created_at","typeLabel":"string\u003cdate-time>"},"promoter":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the promoter","uniqueKey":"items.[INDEX].promoter_campaign.promoter.id","typeLabel":"integer"},"email":{"type":"string","format":"email","description":"Email address of the promoter","uniqueKey":"items.[INDEX].promoter_campaign.promoter.email","typeLabel":"string\u003cemail>"},"name":{"type":"string","description":"Name of the promoter","uniqueKey":"items.[INDEX].promoter_campaign.promoter.name","typeLabel":"string"}},"uniqueKey":"items.[INDEX].promoter_campaign.promoter","typeLabel":"object"},"campaign":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the campaign","uniqueKey":"items.[INDEX].promoter_campaign.campaign.id","typeLabel":"integer"},"name":{"type":"string","description":"Name of the campaign","uniqueKey":"items.[INDEX].promoter_campaign.campaign.name","typeLabel":"string"},"color":{"oneOf":[{"type":"string","description":"Color assigned to the campaign","uniqueKey":"items.[INDEX].promoter_campaign.campaign.color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Color assigned to the campaign","uniqueKey":"items.[INDEX].promoter_campaign.campaign.color.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promoter_campaign.campaign.color","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].promoter_campaign.campaign","typeLabel":"object"}},"uniqueKey":"items.[INDEX].promoter_campaign","typeLabel":"object"},"fraud_check":{"type":"string","enum":["no_suspicion","same_ip_suspicion","same_promoter_email","ad_source"],"description":"Fraud check (suspicion) status of the referral. `no_suspicion` means the referral is clean or was manually cleared. `same_ip_suspicion` means the referral shares an IP with the promoter. `same_promoter_email` means the referral email matches the promoter email. `ad_source` means the referral arrived via a paid ad click.","uniqueKey":"items.[INDEX].fraud_check","typeLabel":"enum\u003cstring>"},"created_by_user_email":{"oneOf":[{"type":"string","format":"email","description":"Email address of the user who created the referral","uniqueKey":"items.[INDEX].created_by_user_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Email address of the user who created the referral","uniqueKey":"items.[INDEX].created_by_user_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].created_by_user_email","typeLabel":"string\u003cemail> | null"},"username":{"oneOf":[{"type":"string","description":"Username chosen by the referral","uniqueKey":"items.[INDEX].username.oneOf.0","typeLabel":"string"},{"type":"null","description":"Username chosen by the referral","uniqueKey":"items.[INDEX].username.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].username","typeLabel":"string | null"},"split_details":{"oneOf":[{"type":"array","description":"The commission split configuration for this referral. Each entry represents a split partner. The primary promoter (the referral owner) receives the remainder of the commission after all split percentages are applied.","items":{"type":"object","properties":{"promoter_campaign_id":{"type":"integer","description":"The ID of the split partner's campaign enrollment","uniqueKey":"items.[INDEX].split_details.oneOf.0.items.[INDEX].promoter_campaign_id","typeLabel":"integer"},"promoter_id":{"type":"integer","description":"The ID of the split partner (promoter)","uniqueKey":"items.[INDEX].split_details.oneOf.0.items.[INDEX].promoter_id","typeLabel":"integer"},"percentage":{"type":"integer","description":"The percentage of each commission this promoter receives","uniqueKey":"items.[INDEX].split_details.oneOf.0.items.[INDEX].percentage","typeLabel":"integer"}},"uniqueKey":"items.[INDEX].split_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].split_details.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"The commission split configuration for this referral. Each entry represents a split partner. The primary promoter (the referral owner) receives the remainder of the commission after all split percentages are applied.","items":{"type":"object","properties":{"promoter_campaign_id":{"type":"integer","description":"The ID of the split partner's campaign enrollment"},"promoter_id":{"type":"integer","description":"The ID of the split partner (promoter)"},"percentage":{"type":"integer","description":"The percentage of each commission this promoter receives"}}},"uniqueKey":"items.[INDEX].split_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].split_details","typeLabel":"object[] | null"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].last_name","typeLabel":"string | null"},"website":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].website.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"items.[INDEX].website.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].website","typeLabel":"string | null"},"comment":{"oneOf":[{"type":"string","description":"Internal note or comment on this referral","uniqueKey":"items.[INDEX].comment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal note or comment on this referral","uniqueKey":"items.[INDEX].comment.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].comment","typeLabel":"string | null"},"is_expired":{"type":"boolean","description":"Whether the referral has expired","uniqueKey":"items.[INDEX].is_expired","typeLabel":"boolean"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":123,"email":"jsmith@example.com","uid":"\u003cstring>","state":"subscribed","metadata":{},"entry_source":"api","created_at":"2023-11-07T05:31:56Z","customer_since":"2023-11-07T05:31:56Z","promoter_campaign":{"id":123,"campaign_id":123,"promoter_id":123,"created_at":"2023-11-07T05:31:56Z","promoter":{"id":123,"email":"jsmith@example.com","name":"\u003cstring>"},"campaign":{"id":123,"name":"\u003cstring>","color":"\u003cstring>"}},"fraud_check":"no_suspicion","created_by_user_email":"jsmith@example.com","username":"\u003cstring>","split_details":[{"promoter_campaign_id":123,"promoter_id":123,"percentage":123}],"first_name":"\u003cstring>","last_name":"\u003cstring>","website":"\u003cstring>","comment":"\u003cstring>","is_expired":true}]}},"exampleType":"generated"}},"exampleType":"generated"},"f4282ccb-3c01-4683-82a1-5b571643da18":{"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"},"50e35bb9-9a2e-4bd9-b674-80a7705b9277":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d11ac46b-5fd2-43c8-baa4-9088fb1b82a5":{"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 → Manage API Keys","scopes":[]}}},"servers":{"ac87d9a9-9c04-4105-b282-5a8446996153":{"url":"https://api.firstpromoter.com/api/v2/company","description":"Production server"}},"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 → Manage API Keys","scopes":[]},"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 → Manage API Keys","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference-v2/api-admin/referrals/openapi-v2-referrals.json"},"subdomain":"firstpromoter","siteName":"FirstPromoter Docs","title":"Get available referrals - FirstPromoter Docs","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference-v2/api-admin/referrals/get-referrals","matchLevel":0},"v1":{"href":"/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2025-09-24T16:23:41.401Z","originalFileLocation":"api-reference-v2/api-admin/referrals/get-referrals.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=\"Get available referrals HTTP Request GET https://api.firstpromoter.com/api/v2/company/referrals\">\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 available referrals - FirstPromoter Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get available referrals HTTP Request GET https://api.firstpromoter.com/api/v2/company/referrals\">\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/referrals/get-referrals\">\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=Referrals\u0026amp;title=Get+available+referrals\u0026amp;description=Get+available+referrals+%0A+%3CTip%3E**HTTP+Request**+%3Cbr%2F%3E%60GET+https%3A%2F%2Fapi.firstpromoter.com%2Fapi%2Fv2%2Fcompany%2Freferrals%60%3C%2FTip%3E\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=d1e4d8def858616e2671fc15332f9b3e5b0427c9aa57018fcb3972d0caf305af\">\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 available referrals - FirstPromoter Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get available referrals HTTP Request GET https://api.firstpromoter.com/api/v2/company/referrals\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firstpromoter.mintlify.app/_mintlify/api/og/v2?division=Referrals\u0026amp;title=Get+available+referrals\u0026amp;description=Get+available+referrals+%0A+%3CTip%3E**HTTP+Request**+%3Cbr%2F%3E%60GET+https%3A%2F%2Fapi.firstpromoter.com%2Fapi%2Fv2%2Fcompany%2Freferrals%60%3C%2FTip%3E\u0026amp;theme=6c5c6938239eba73fb25a5bd\u0026amp;signature=d1e4d8def858616e2671fc15332f9b3e5b0427c9aa57018fcb3972d0caf305af\">\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/referrals/get-referrals\">\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/referrals/get-referrals.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/referrals/get-referrals#webpage\",\"url\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/referrals/get-referrals\",\"name\":\"Get available referrals\",\"description\":\"Get available referrals HTTP Request GET https://api.firstpromoter.com/api/v2/company/referrals\",\"dateModified\":\"2025-09-24T16:23:41.401Z\",\"isPartOf\":{\"@id\":\"https://docs.firstpromoter.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/referrals/get-referrals#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/referrals/get-referrals#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"FirstPromoter Docs\",\"item\":\"https://docs.firstpromoter.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get available referrals\",\"item\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/referrals/get-referrals\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/referrals/get-referrals#apireference\",\"headline\":\"Get available referrals\",\"name\":\"Get available referrals\",\"description\":\"Get available referrals HTTP Request GET https://api.firstpromoter.com/api/v2/company/referrals\",\"url\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/referrals/get-referrals\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firstpromoter.com/api-reference-v2/api-admin/referrals/get-referrals#webpage\"},\"dateModified\":\"2025-09-24T16:23:41.401Z\",\"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":"FirstPromoter API v2 Introduction","sidebarTitle":"Introduction","href":"/api-reference-v2/api-admin/introduction"},{"title":"FirstPromoter API v2 Authentication","sidebarTitle":"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","description":"This call will mark the customer as cancelled and will decrease the MRR generated by them. \u003cTip>**HTTP Request** \u003cbr/>`POST https://api.firstpromoter.com/api/v2/track/cancellation`\u003c/Tip>","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","description":"Get a specific referral \n \u003cTip>**HTTP Request** \u003cbr/>`GET https://api.firstpromoter.com/api/v2/company/referrals/{id}`\u003c/Tip>","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","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","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":"/introduction"}]}]},"basePath":"","title":"Get available referrals - FirstPromoter Docs","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}