CINXE.COM
What is PartnerStack?
<!DOCTYPE html><html lang="en" style="" data-color-mode="light" class=" useReactApp "><head><meta charset="utf-8"><meta name="readme-deploy" content="5.322.0"><meta name="readme-subdomain" content="partnerstack"><meta name="readme-version" content="2.0"><title>What is PartnerStack?</title><meta name="description" content="PartnerStack helps partnership teams easily scale their program revenue by automating a variety of partner referral and sales motions in a single dashboard. PartnerStack makes it simple to manage your partner onboarding and training, ongoing partner engagement, as well as revenue, sales, and commiss..."><meta property="og:title" content="What is PartnerStack?"><meta property="og:description" content="PartnerStack helps partnership teams easily scale their program revenue by automating a variety of partner referral and sales motions in a single dashboard. PartnerStack makes it simple to manage your partner onboarding and training, ongoing partner engagement, as well as revenue, sales, and commiss..."><meta property="og:site_name" content="PartnerStack"><meta name="twitter:title" content="What is PartnerStack?"><meta name="twitter:description" content="PartnerStack helps partnership teams easily scale their program revenue by automating a variety of partner referral and sales motions in a single dashboard. PartnerStack makes it simple to manage your partner onboarding and training, ongoing partner engagement, as well as revenue, sales, and commiss..."><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/ca13b47-small-PartnerStack-logo-pack-2022_Primary_Logo_Horizontal_Full-color.png"><meta name="twitter:image" content="https://files.readme.io/ca13b47-small-PartnerStack-logo-pack-2022_Primary_Logo_Horizontal_Full-color.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/e7ba444-small-PartnerStack-logo-pack-2022_Icon-only_Full-color.png" type="image/png"><link rel="canonical" href="https://docs.partnerstack.com/docs/getting-started"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1743783937684"></script><link data-chunk="SuperHub-CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.6f815c83f54659ae791f.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.7e7736cc7c5b0affc361.css"> <link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.0b0b64406047e2a3670a.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.b6e3c66bfa4e65097f5f.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.59e02500db2c520b4509.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.883d037c9b5898d42a5d.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="Footer" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.0ab6d6e327e2be33020a.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.4c8c34bca506869e518a.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.7e7ac3b831d39ed8ef99.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/7188.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.4c43266695a6f2b7b2bf.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.00d6092e308f6e31fd7a.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.f2baed1db5157d5aeba1.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1126.9d43ffa1039df16a8271.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6563.fbd3d15eee3b5e94f665.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.89a3e895d3051e33cd73.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4904.1067704c85da57778e22.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.fbd27ab77e6e47de9931.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/187.23cea47109f7f88417f6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1167.a6c63c62c8690225da20.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.771431a607874f268eb2.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9321.7bab74274e71e18bb347.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3073.ef6aff2d0ae6023765f1.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1008.2407cb357f385eb9ff9c.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7188.f444adf64944d115c52b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5753.72c5d7402efc1cfa5881.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.3432b44653552d31effc.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2249.08687f22f6d6de29577d.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3901.9a23139e8c32bd6a1186.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.54e7cbd61e710313e1e0.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.415a3e3f42422a2546f5.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4201.9726bbf672400e046cc2.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.ab23d1cf8ea817ed6084.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.732d39065ba473dca3be.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.05be16260f5ffacc35a3.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.0ba0ba3778e78d8254e8.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.e4a4a4dbb41ce1f8c60f.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3906.b84848dda7e7f59abf47.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.43a15229736801911d5a.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8230.178147e4516bfa8b760d.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.a6b1c6bee69d46fd161f.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.fcff689c44b953a512d6.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/CustomPage.29543915f3e70fa960d7.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.48b876dfa499613f04d9.js"> <link data-chunk="core-icons-key-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.9a682a77c9083927aeaf.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.d47bf77a75f266a70e80.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.6d18db72aa3774dd903a.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="RMDX" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/RMDX.6966846032c03969e44f.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.b1dd4485529aa4a7aa11.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.19db37c76f3b9d17353d.js"> <link data-chunk="core-icons-chevron-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-right-svg.34d126524d8ea236d174.js"> <link data-chunk="core-icons-code-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-code-svg.d29a4cf99a7105e13528.js"> <link data-chunk="core-icons-plus-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-plus-svg.a49fb76ac2661b5e1c7e.js"> <link data-chunk="core-icons-book-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"> <link data-chunk="core-icons-gauge-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-gauge-circle-svg.fff25782546fef314a09.js"> <link data-chunk="core-icons-folder-plus-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-folder-plus-svg.2c200438e59611867262.js"> <link data-chunk="core-icons-settings-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-settings-svg.bb875a1c38f51ce460bd.js"> <link data-chunk="core-icons-oas-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-oas-svg.2dabf01f334b141bfe4b.js"> <link data-chunk="core-icons-help-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-help-circle-svg.5b015602206396831950.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c83f9bb228d60f5f7f6b.js"> <link data-chunk="SuperHub-CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.edef7b501475b233c5a2.js"> <link data-chunk="core-icons-unlock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-unlock-svg.d27591cc9e0be731e26d.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.00d6092e308f6e31fd7a.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.4c43266695a6f2b7b2bf.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/7188.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.7e7ac3b831d39ed8ef99.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.4c8c34bca506869e518a.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.0ab6d6e327e2be33020a.css"> <link data-chunk="Footer" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.883d037c9b5898d42a5d.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.59e02500db2c520b4509.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.b6e3c66bfa4e65097f5f.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.0b0b64406047e2a3670a.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.7e7736cc7c5b0affc361.css"> <link data-chunk="SuperHub-CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.6f815c83f54659ae791f.css"><!-- CUSTOM CSS--><style title="rm-custom-css">:root{--project-color-primary:#434de1;--project-color-inverse:#fff;--recipe-button-color:#434de1;--recipe-button-color-hover:#1a23a4;--recipe-button-color-active:#131a78;--recipe-button-color-focus:rgba(67, 77, 225, 0.25);--recipe-button-color-disabled:#f3f4fd}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#434de1;--project-color-inverse:#fff}a{color:var(--color-link-primary,#434de1)}a:hover{color:var(--color-link-primary-darken-5,#1a23a4)}a.text-muted:hover{color:var(--color-link-primary,#434de1)}.btn.btn-primary{background-color:#434de1}.btn.btn-primary:hover{background-color:#1a23a4}.theme-line #hub-landing-top h2{color:#434de1}#hub-landing-top .btn:hover{color:#434de1}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#434de1}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#434de1,#b8cedc)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(https://files.readme.io/fc355d8-Green_Banner.png)}.theme-line header#hub-header #header-top{border-bottom-color:#434de1}.theme-line header#hub-header #header-top .btn{background-color:#434de1}header#hub-header #header-top #header-logo{width:117px;height:40px;margin-top:0;background-image:url(https://files.readme.io/ca13b47-small-PartnerStack-logo-pack-2022_Primary_Logo_Horizontal_Full-color.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#434de1}#subheader-links a.active{color:#434de1!important;box-shadow:inset 0 -2px 0 #434de1}#subheader-links a:hover{color:#434de1!important;box-shadow:inset 0 -2px 0 #434de1;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#434de1}section#hub-discuss .discussion a .discuss-body h4{color:#434de1}section#hub-discuss .discussion a:hover .discuss-body h4{color:#1a23a4}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#434de1}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#434de1}#hub-search-results h3 em{color:#434de1}.main_background,.tag-item{background:#434de1!important}.main_background:hover{background:#1a23a4!important}.main_color{color:#434de1!important}.border_bottom_main_color{border-bottom:2px solid #434de1}.main_color_hover:hover{color:#434de1!important}section#hub-discuss h1{color:#434de1}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#434de1;background-color:#434de1}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#1a23a4;border-color:#1a23a4}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#434de1;color:#434de1}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#434de1);border-color:var(--project-color-primary,#434de1)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#1a23a4;border-color:#1a23a4}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#434de1;fill:var(--project-color-primary,#434de1)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#434de1}.main-color-accent{border-bottom:3px solid #434de1;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES */p{color:#555}li.subnav-expanded.subnav-soft-toggle>a.text-wrap{color:#fff!important}li.subnav-expanded.hub-sidebar-page>a.text-wrap{color:#fff!important}div.response-schema code.rdmd-code{background:rgb(255 255 255 / 10%)!important;color:#fff!important}/*! END HUB_CUSTOM_STYLES */</style><meta name="loadedProject" content="partnerstack"><script src="//use.typekit.net/rnd8okf.js"></script><script>try{Typekit.load();}catch(e){} </script><script>var storedColorMode = `light` === 'system' ? window.localStorage.getItem('color-scheme') : `light` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.322.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-overlap theme-line header-overlay header-bg-size-cover header-bg-pos-tl header-overlay-triangles reference-layout-column lumosity-normal "><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark ThemeContext_line" style="--color-primary:#434de1;--color-primary-inverse:#fff;--color-primary-alt:#b8cedc;--color-primary-darken-10:#212cd0;--color-primary-darken-20:#1a23a4;--color-primary-alpha-25:rgba(67, 77, 225, 0.25);--color-link-primary:#434de1;--color-link-primary-darken-5:#2d38dd;--color-link-primary-darken-10:#212cd0;--color-link-primary-darken-20:#1a23a4;--color-link-primary-alpha-50:rgba(67, 77, 225, 0.5);--color-link-primary-alpha-25:rgba(67, 77, 225, 0.25);--color-link-background:rgba(67, 77, 225, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/" target="_self"><img alt="PartnerStack" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/ca13b47-small-PartnerStack-logo-pack-2022_Primary_Logo_Horizontal_Full-color.png"/></a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text rm-Header-top-link_active Header-link2tXYTgXq85zW active" href="/docs" target="_self">Guides</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/reference" target="_self">API Reference</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/" target="_self"><i class="icon-landing-page-2 NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Home</span></a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><select class="Select Select_md NavItem-item1gDDTqaXGhm1 NavItem-item_select3UEfLN-oSjxp NavItem-item_mobile1qG3gd-Mkck-"><option data-url="/v1.0/docs" value="1.0">v1.0</option><option selected="" data-url="#" value="2.0">v2.0</option></select><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74 active" href="/docs" target="_self">Guides</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/reference" target="_self">API Reference</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://support.partnerstack.com/hc/en-us" rel="noopener" target="_blank" to="https://support.partnerstack.com/hc/en-us">Support</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://dash.partnerstack.com" rel="noopener" target="_blank" to="https://dash.partnerstack.com">PartnerStack Login</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/" target="_self"><img alt="PartnerStack" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/ca13b47-small-PartnerStack-logo-pack-2022_Primary_Logo_Horizontal_Full-color.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-guides Header-left-nav-icon10glJKFwewOv"></i>Guides</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://support.partnerstack.com/hc/en-us" target="_self" to="https://support.partnerstack.com/hc/en-us">Support</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://dash.partnerstack.com" target="_self" to="https://dash.partnerstack.com">PartnerStack Login</a></span><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav aria-label="Primary navigation" class="Header-leftADQdGVqx1wqU" role="navigation"><div class="rm-VersionDropdown Dropdown Dropdown_closed"><button aria-haspopup="dialog" class="Button Button_slate_text Button_md rm-Header-bottom-link Dropdown-toggle Button_primary" type="button"><span class="Truncate1OzxBYrNNfH3" style="--Truncate-max-width:150px">v2.0</span><i class="icon icon-chevron-down"></i></button></div><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/" target="_self"><i class="icon-landing-page-2"></i><span>Home</span></a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/docs" target="_self"><i class="icon-guides"></i><span>Guides</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/reference" target="_self"><i class="icon-references"></i><span>API Reference</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">What is PartnerStack?</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="rm-Guides"><div class="rm-Container rm-Container_flex"><nav aria-label="Secondary navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj rm-Sidebar_guides" id="hub-sidebar" role="navigation"><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Getting Started</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link active" target="_self" href="/docs/getting-started"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">What is PartnerStack?</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/plan-your-implementation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Planning your implementation" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Planning your implementation</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/glossary-and-objects"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Glossary</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/object-model"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Object model</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Integration Suite</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/getting-started-with-the-integration-suite"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to Workato</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Tracking Links with PartnerStackJS</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/partnerstackjs"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Introduction to link tracking" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to link tracking</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/step-1-install-partnerstackjs"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 1: Install PartnerStackJS</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/step-2-track-signup-events"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 2: Track Signup Events</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/step-3-testing-and-debugging"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 3: Testing and Debugging</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/examples"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Examples" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Examples</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/hubspot-forms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">HubSpot Forms</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/hubspot-forms-iframe"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">HubSpot Forms (iFrame)</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/marketo-forms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Marketo Forms</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/google-tag-manager-1"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Google Tag Manager</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/advanced-usage"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Advanced Usage</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Tracking Links with S2S</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/server-to-server-s2s-tracking"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Introduction to server to server (S2S) tracking" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to server to server (S2S) tracking</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/getting-integrated-with-s2s"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 1: Getting Click ID</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/step-2-create-token-to-authorize-s2s-requests"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 2: Create Token to authorize S2S requests</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/step-3-tracking-conversions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 3: Tracking conversions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/step-4-where-to-see-this-data-in-partnerstack"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Step 4: Where to see this data in PartnerStack</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/migrating-customer-api-to-server-to-server"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Transitioning from Customer API to S2S tracking</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Capturing Channel Pipeline</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/introduction"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to Leads & Deals</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/lead-to-crm"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Sync Leads to CRM</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/sync-deals-to-crm"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Sync Deals to CRM</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/sync-crm-to-deals"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Push new leads to partners</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Guides</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/hubspot"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for HubSpot" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">HubSpot</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/hubspot-authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">HubSpot Authentication</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/syncing-leads-to-hubspot-contacts"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Syncing Leads to HubSpot contacts</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/salesforce"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Salesforce" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Salesforce</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/salesforce-authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Salesforce Authentication</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/syncing-deals-to-salesforce-opportunities"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Syncing Deals to Salesforce Opportunities</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/pipedrive"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Pipedrive" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Pipedrive</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/pipedrive-authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Pipedrive Authentication</span></span></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">API and Webhooks</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/partnerstack-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Vendor API" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Vendor API</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/partnerstack-webhooks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Webhooks</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://docs.partnerstack.com/reference/auth"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Vendor API reference</span></span><i aria-label="Link opens in a new tab" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/partner-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Partner API" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Partner API</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/postbacks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Postbacks</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://docs.partnerstack.com/reference/partner-api-authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Partner API reference</span></span><i aria-label="Link opens in a new tab" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li></ul></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Tracking Payments</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/introduction-payments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to payment webhooks</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/stripe-webhook"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Stripe Payment Tracking</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/recurly-webhook"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Recurly Webhook</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/chargebee-webhook"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Chargebee Webhook</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/chargify-webhook"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Chargify Webhook</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/paddle-checkout"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Paddle checkout</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/troubleshooting-webhooks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Testing and Troubleshooting Payment Tracking</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Security and Compliance</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/fraud-monitoring"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Fraud Monitoring</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/user-authentication-saml-oauth"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">User Authentication (SAML, OAuth)</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/gdpr-ccpa"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">GDPR & CCPA</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" rel="noopener" target="_blank" data-active="" href="https://trust.partnerstack.com/"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Security & SOC2 Reports</span></span><i aria-label="Link opens in a new tab" class="Sidebar-link-externalIcon1RcnjKm-3Ft8 icon-arrow-up-right"></i></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Testing Integrations</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/introduction-testing"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction to testing</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/creating-test-partner"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Creating Test Partner</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/referral-link-flow"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Referral Link Flow</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/lead-submission-flow"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Lead Submission Flow</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/deal-registration-flow"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Deal Registration Flow</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/sending-test-transactions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Sending Test Transactions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/rewards-with-triggers"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Rewards with Triggers</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/next-steps"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Next Steps</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Import</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/universal-importer"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Data Importer</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Customer Referral Widget</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/referral-iframe"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Referral iFrame</span></span></a></li></ul></section></div></nav><article class="rm-Article " id="content"><header id="content-head"><div class="row clearfix"><div class="col-xs-9"><h1>What is PartnerStack?</h1></div><div class="col-xs-3"><a class="suggestEdits" rel="nofollow" href="/edit/getting-started"><i aria-hidden="true" class="icon icon-edit"></i> Suggest Edits</a></div></div></header><div class="grid-container-fluid" id="content-container"><section class="content-body grid-75"><div dehydrated="<p>PartnerStack helps partnership teams easily scale their program revenue by automating a variety of partner referral and sales motions in a single dashboard.</p> <p>PartnerStack makes it simple to manage your partner onboarding and training, ongoing partner engagement, as well as revenue, sales, and commissions payments.</p> <p>The features of PartnerStack are tightly coupled with integrations that easily connect your partner channel with your core business sales, support, and billing tools. </p> <p>PartnerStack connects to key events in your business to:</p> <ul> <li>automate partner attribution</li> <li>transparently communicate sales pipeline between partners and your internal CRM</li> <li>report on partner performance</li> </ul> <p>If you&#x27;re new to PartnerStack or partnerships, this short 5-minute overview video introduces you to the core concepts within PartnerStack.</p> <div class="embed embed_hasImg"><div class="embed-media"><iframe class="embedly-embed" src="//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Ffast.wistia.net%2Fembed%2Fiframe%2F7i8ihq2fy6&display_name=Wistia%2C+Inc.&url=https%3A%2F%2Fpartnerstack.wistia.com%2Fmedias%2F7i8ihq2fy6&image=https%3A%2F%2Fembed-ssl.wistia.com%2Fdeliveries%2F62602a3143e256e9cdccdaf522cf10350adc287c.jpg%3Fimage_crop_resized%3D960x540&key=f2aa6fc3595946d0afc3d76cbbd25dc3&type=text%2Fhtml&schema=wistia" width="960" height="540" scrolling="no" title="Wistia, Inc. embed" frameborder="0" allow="autoplay; fullscreen" allowfullscreen="true"></iframe></div></div>" style="margin-left:31px" class="rm-Markdown markdown-body rm-Markdown markdown-body ng-non-bindable" data-testid="RDMD"><p>PartnerStack helps partnership teams easily scale their program revenue by automating a variety of partner referral and sales motions in a single dashboard.</p> <p>PartnerStack makes it simple to manage your partner onboarding and training, ongoing partner engagement, as well as revenue, sales, and commissions payments.</p> <p>The features of PartnerStack are tightly coupled with integrations that easily connect your partner channel with your core business sales, support, and billing tools. </p> <p>PartnerStack connects to key events in your business to:</p> <ul> <li>automate partner attribution</li> <li>transparently communicate sales pipeline between partners and your internal CRM</li> <li>report on partner performance</li> </ul> <p>If you're new to PartnerStack or partnerships, this short 5-minute overview video introduces you to the core concepts within PartnerStack.</p> <div class="embed embed_hasImg"><div class="embed-media"><iframe class="embedly-embed" src="//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Ffast.wistia.net%2Fembed%2Fiframe%2F7i8ihq2fy6&display_name=Wistia%2C+Inc.&url=https%3A%2F%2Fpartnerstack.wistia.com%2Fmedias%2F7i8ihq2fy6&image=https%3A%2F%2Fembed-ssl.wistia.com%2Fdeliveries%2F62602a3143e256e9cdccdaf522cf10350adc287c.jpg%3Fimage_crop_resized%3D960x540&key=f2aa6fc3595946d0afc3d76cbbd25dc3&type=text%2Fhtml&schema=wistia" width="960" height="540" scrolling="no" title="Wistia, Inc. embed" frameborder="0" allow="autoplay; fullscreen" allowfullscreen="true"></iframe></div></div></div><div class="UpdatedAt"><p class="DateLine "><i class="icon icon-watch"></i>Updated<!-- --> <!-- -->over 1 year ago<!-- --> </p></div><hr class="NextStepsDivider"/><div class="WhatsNext-wrapper3DTnpcPqKoHg"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader WhatsNext-headingQHN33r4trf_s"><div class="APISectionHeader-heading4MUMLbp4_nLs">What's next...</div></header><div class="rm-Markdown markdown-body WhatsNext-description1zZyZLPCGmaa" data-testid="RDMD"><p>Begin your implementation plan by learning about PartnerStack objects and the partnership industry</p></div><ul><li><a class="WhatsNext-link" target="_self" href="/docs/plan-your-implementation">Planning your implementation</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li></ul></div></section><section class="content-toc grid-25"></section></div><div class="ModalWrapper" id="tutorialmodal-root"></div></article></div></main><footer aria-label="Status banner" class="Footer2U8XAPoGhlgO AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"600ef58ee2a122003d3c04be","order":0,"__v":0,"sync":{"url":"","isSync":false},"createdAt":"2016-09-11T18:31:48.146Z","from_sync":false,"title":"Getting Started","project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","reference":false,"slug":"guides","isAPI":false,"pages":[{"_id":"600ef58ee2a122003d3c04d1","category":"600ef58ee2a122003d3c04be","link_url":"","order":0,"parentDoc":null,"title":"What is PartnerStack?","hidden":false,"link_external":false,"slug":"getting-started","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":""},"sync_unique":"","createdAt":"2015-06-02T22:22:26.497Z","isReference":false,"type":"basic","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61e205837d794f003c5678e9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Planning your implementation","type":"basic","slug":"plan-your-implementation","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-14T23:21:39.664Z","category":"600ef58ee2a122003d3c04be","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[{"_id":"61ddbe5bb6de8801f389fe3a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Glossary","type":"basic","slug":"glossary-and-objects","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-11T17:28:59.649Z","category":"600ef58ee2a122003d3c04be","parentDoc":"61e205837d794f003c5678e9","icon":"","isBodyEmpty":false,"children":[]},{"_id":"61ddc162d18b2e0062667fc5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Object model","type":"basic","slug":"object-model","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-11T17:41:54.277Z","parentDoc":"61e205837d794f003c5678e9","category":"600ef58ee2a122003d3c04be","icon":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"61df79098186e601ed11b96d","title":"Integration Suite","slug":"integration-suite","order":1,"reference":false,"isAPI":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2022-01-13T00:57:45.436Z","__v":0,"pages":[{"_id":"61df793e5daf790059e23dfb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Introduction to Workato","type":"basic","slug":"getting-started-with-the-integration-suite","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-13T00:58:38.951Z","category":"61df79098186e601ed11b96d","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"605bf12d01db370016cb3bfd","title":"Tracking Links with PartnerStackJS","slug":"partnerstackjs","order":3,"reference":false,"isAPI":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2021-03-25T02:10:53.617Z","__v":0,"pages":[{"_id":"605d2acb05290c0044c7df21","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Introduction to link tracking","type":"basic","slug":"partnerstackjs","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction","createdAt":"2021-03-26T00:28:59.801Z","category":"605bf12d01db370016cb3bfd","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[{"_id":"605d2ad92e8c400072dcb931","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Step 1: Install PartnerStackJS","type":"basic","slug":"step-1-install-partnerstackjs","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-03-26T00:29:13.522Z","category":"605bf12d01db370016cb3bfd","parentDoc":"605d2acb05290c0044c7df21","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"605d2ae305290c0044c7df29","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Step 2: Track Signup Events","type":"basic","slug":"step-2-track-signup-events","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-03-26T00:29:23.121Z","category":"605bf12d01db370016cb3bfd","parentDoc":"605d2acb05290c0044c7df21","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"605d2aee83ea9305fd370416","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Step 3: Testing and Debugging","type":"basic","slug":"step-3-testing-and-debugging","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-03-26T00:29:34.544Z","category":"605bf12d01db370016cb3bfd","parentDoc":"605d2acb05290c0044c7df21","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"605d2af693b77f061ac054a3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Examples","type":"basic","slug":"examples","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-03-26T00:29:42.900Z","category":"605bf12d01db370016cb3bfd","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"605d2b004cbc4b0012b77c64","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"HubSpot Forms","type":"basic","slug":"hubspot-forms","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-03-26T00:29:52.513Z","parentDoc":"605d2af693b77f061ac054a3","category":"605bf12d01db370016cb3bfd","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6091a1883ecbe5000fcf885b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"HubSpot Forms (iFrame)","type":"basic","slug":"hubspot-forms-iframe","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-05-04T19:33:28.275Z","parentDoc":"605d2af693b77f061ac054a3","category":"605bf12d01db370016cb3bfd","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"605d2b14f6175e0057fa8796","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Marketo Forms","type":"basic","slug":"marketo-forms","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-03-26T00:30:12.492Z","parentDoc":"605d2af693b77f061ac054a3","category":"605bf12d01db370016cb3bfd","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"605d2b1c2a0bf7003f3e180a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Google Tag Manager","type":"basic","slug":"google-tag-manager-1","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-03-26T00:30:20.883Z","parentDoc":"605d2af693b77f061ac054a3","category":"605bf12d01db370016cb3bfd","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"605d2b29dab12b003deef9d4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Advanced Usage","type":"basic","slug":"advanced-usage","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-03-26T00:30:33.065Z","category":"605bf12d01db370016cb3bfd","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"63d3ec4cfb028e00a603f6aa","title":"Tracking Links with S2S","slug":"tracking-links-with-s2s","order":5,"reference":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2023-01-27T15:22:52.618Z","__v":0,"pages":[{"_id":"63d3eb0fef68a90024a95031","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Introduction to server to server (S2S) tracking","icon":"","type":"basic","slug":"server-to-server-s2s-tracking","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"63d3ec4cfb028e00a603f6aa","createdAt":"2023-01-27T15:17:35.154Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63d3ecfd3ca0920023e0b99e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Step 1: Getting Click ID","icon":"","type":"basic","slug":"getting-integrated-with-s2s","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"63d3ec4cfb028e00a603f6aa","createdAt":"2023-01-27T15:25:49.880Z","parentDoc":"63d3eb0fef68a90024a95031","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"63d3ee2940a31b00907798e1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Step 2: Create Token to authorize S2S requests","icon":"","type":"basic","slug":"step-2-create-token-to-authorize-s2s-requests","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63d3eb0fef68a90024a95031","category":"63d3ec4cfb028e00a603f6aa","createdAt":"2023-01-27T15:30:49.177Z","isBodyEmpty":false,"children":[]},{"_id":"63d3ef36228635002c96577f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Step 3: Tracking conversions","icon":"","type":"basic","slug":"step-3-tracking-conversions","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63d3eb0fef68a90024a95031","category":"63d3ec4cfb028e00a603f6aa","createdAt":"2023-01-27T15:35:18.920Z","isBodyEmpty":false,"children":[]},{"_id":"63d3efb1eeadf3005ec3b216","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Step 4: Where to see this data in PartnerStack","icon":"","type":"basic","slug":"step-4-where-to-see-this-data-in-partnerstack","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63d3eb0fef68a90024a95031","category":"63d3ec4cfb028e00a603f6aa","createdAt":"2023-01-27T15:37:21.269Z","isBodyEmpty":false,"children":[]}]},{"_id":"6577416a2e988f006cf38788","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Transitioning from Customer API to S2S tracking","icon":"","type":"basic","slug":"migrating-customer-api-to-server-to-server","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"test","category":"63d3ec4cfb028e00a603f6aa","createdAt":"2023-12-11T17:05:46.564Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"61e44408d45a39002a020084","title":"Capturing Channel Pipeline","slug":"capturing-channel-pipeline","order":6,"reference":false,"isAPI":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2022-01-16T16:12:56.838Z","__v":0,"pages":[{"_id":"61e446d093b4250032116c77","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Introduction to Leads & Deals","type":"basic","slug":"introduction","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-16T16:24:48.758Z","category":"61e44408d45a39002a020084","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61e45aa859c7c40102f1ee16","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Sync Leads to CRM","type":"basic","slug":"lead-to-crm","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-16T17:49:28.588Z","category":"61e44408d45a39002a020084","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61e48986cffcf80069bacb40","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Sync Deals to CRM","type":"basic","slug":"sync-deals-to-crm","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-16T21:09:26.443Z","category":"61e44408d45a39002a020084","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"62824a723dd7de007b6aa0f0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Push new leads to partners","type":"basic","slug":"sync-crm-to-deals","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-05-16T12:58:26.848Z","category":"61e44408d45a39002a020084","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"61e48f9613b4d00016050de8","title":"Guides","slug":"guides-1","order":7,"reference":false,"isAPI":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2022-01-16T21:35:18.109Z","__v":0,"pages":[{"_id":"61e493d559caf3006a631b62","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"HubSpot","type":"basic","slug":"hubspot","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"hubspot-guides","createdAt":"2022-01-16T21:53:25.470Z","category":"61e48f9613b4d00016050de8","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[{"_id":"613a01db92cd0a006a20509b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"HubSpot Authentication","type":"basic","slug":"hubspot-authentication","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"hubspot","createdAt":"2021-09-09T12:45:15.752Z","category":"61e48f9613b4d00016050de8","parentDoc":"61e493d559caf3006a631b62","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61e4e5a0d8ec8a007ad565c3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Syncing Leads to HubSpot contacts","type":"basic","slug":"syncing-leads-to-hubspot-contacts","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-17T03:42:24.277Z","category":"61e48f9613b4d00016050de8","parentDoc":"61e493d559caf3006a631b62","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"61e49911b034080023b372b6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Salesforce","type":"basic","slug":"salesforce","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-16T22:15:45.297Z","category":"61e48f9613b4d00016050de8","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[{"_id":"612808aef9e170002a8af667","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Salesforce Authentication","type":"basic","slug":"salesforce-authentication","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"salesforce","createdAt":"2021-08-26T21:33:34.766Z","category":"61e48f9613b4d00016050de8","parentDoc":"61e49911b034080023b372b6","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61e4e60e58b190001296da80","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Syncing Deals to Salesforce Opportunities","type":"basic","slug":"syncing-deals-to-salesforce-opportunities","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-17T03:44:14.045Z","parentDoc":"61e49911b034080023b372b6","category":"61e48f9613b4d00016050de8","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"627e740a7fdb7a01b07d766e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Pipedrive","type":"basic","slug":"pipedrive","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-05-13T15:06:50.138Z","category":"61e48f9613b4d00016050de8","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[{"_id":"627e8962f1213500427f0d18","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Pipedrive Authentication","type":"basic","slug":"pipedrive-authentication","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"627e740a7fdb7a01b07d766e","createdAt":"2022-05-13T16:37:54.908Z","category":"61e48f9613b4d00016050de8","icon":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"61df6fe49fc45102c5b6f335","title":"API and Webhooks","slug":"api-and-webhooks","order":8,"reference":false,"isAPI":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2022-01-13T00:18:44.165Z","__v":0,"pages":[{"_id":"600ef58ee2a122003d3c04e9","category":"61df6fe49fc45102c5b6f335","createdAt":"2017-06-16T05:09:23.661Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":false,"order":0,"slug":"partnerstack-api","type":"basic","title":"Vendor API","parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"6038732ae3d648006428e4eb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Webhooks","type":"basic","slug":"partnerstack-webhooks","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-02-26T04:03:54.637Z","category":"61df6fe49fc45102c5b6f335","parentDoc":"600ef58ee2a122003d3c04e9","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61df8108d696920017d0d502","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Vendor API reference","type":"link","slug":"vendor-api-reference","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://docs.partnerstack.com/reference/auth","link_external":true,"previousSlug":"","createdAt":"2022-01-13T01:31:52.291Z","category":"61df6fe49fc45102c5b6f335","parentDoc":"600ef58ee2a122003d3c04e9","icon":"","isBodyEmpty":true,"children":[]}]},{"_id":"608af130bc9b8a0023653c4a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Partner API","type":"basic","slug":"partner-api","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-29T17:47:28.846Z","category":"61df6fe49fc45102c5b6f335","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"61116a8ec5d46a001e0ef2dc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Postbacks","type":"basic","slug":"postbacks","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-09T17:49:02.348Z","parentDoc":"608af130bc9b8a0023653c4a","category":"61df6fe49fc45102c5b6f335","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61df8135d696920017d0d566","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Partner API reference","type":"link","slug":"partner-api-reference","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://docs.partnerstack.com/reference/partner-api-authentication","link_external":true,"previousSlug":"","parentDoc":"608af130bc9b8a0023653c4a","createdAt":"2022-01-13T01:32:37.527Z","category":"61df6fe49fc45102c5b6f335","icon":"","isBodyEmpty":true,"children":[]}]}]},{"_id":"600ef58ee2a122003d3c04c2","project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","isAPI":false,"reference":false,"createdAt":"2017-06-16T01:38:22.142Z","from_sync":false,"order":9,"slug":"payment-tracking","title":"Tracking Payments","__v":0,"pages":[{"_id":"6088003df11f9400417dfde9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Introduction to payment webhooks","type":"basic","slug":"introduction-payments","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction","createdAt":"2021-04-27T12:14:53.758Z","category":"600ef58ee2a122003d3c04c2","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"600ef58ee2a122003d3c04d8","order":1,"title":"Stripe Payment Tracking","type":"basic","link_external":false,"link_url":"","slug":"stripe-webhook","sync_unique":"","hidden":false,"parentDoc":null,"api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"method":"get","examples":{"codes":[]}},"isReference":false,"category":"600ef58ee2a122003d3c04c2","createdAt":"2016-09-11T18:32:06.240Z","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"600ef58ee2a122003d3c04d9","category":"600ef58ee2a122003d3c04c2","sync_unique":"","order":2,"parentDoc":null,"title":"Recurly Webhook","hidden":false,"isReference":false,"link_external":false,"type":"basic","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","method":"get","examples":{"codes":[]}},"createdAt":"2016-09-11T18:32:12.343Z","link_url":"","slug":"recurly-webhook","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"600ef58ee2a122003d3c04da","category":"600ef58ee2a122003d3c04c2","parentDoc":null,"title":"Chargebee Webhook","slug":"chargebee-webhook","sync_unique":"","type":"basic","api":{"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","method":"get","examples":{"codes":[]}},"createdAt":"2016-09-11T18:32:20.097Z","isReference":false,"hidden":false,"link_external":false,"link_url":"","order":3,"previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"600ef58ee2a122003d3c04f1","category":"600ef58ee2a122003d3c04c2","createdAt":"2017-06-21T15:10:57.517Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get","examples":{"codes":[]}},"isReference":false,"order":4,"slug":"chargify-webhook","type":"basic","title":"Chargify Webhook","parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"64dbeb2a1892320020de93ec","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Paddle checkout","icon":"","type":"basic","slug":"paddle-checkout","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"600ef58ee2a122003d3c04c2","createdAt":"2023-08-15T21:16:26.766Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"608c3ef3e3d01f0396fb192e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Testing and Troubleshooting Payment Tracking","type":"basic","slug":"troubleshooting-webhooks","order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-30T17:31:31.654Z","category":"600ef58ee2a122003d3c04c2","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"61df6c48854879002316a70a","title":"Security and Compliance","slug":"fraud-and-security","order":10,"reference":false,"isAPI":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2022-01-13T00:03:20.544Z","__v":0,"pages":[{"_id":"61df6c7fb45be900796a441b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Fraud Monitoring","type":"basic","slug":"fraud-monitoring","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-13T00:04:15.100Z","category":"61df6c48854879002316a70a","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"634eca66130188004f60dcd8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"User Authentication (SAML, OAuth)","icon":"","type":"basic","slug":"user-authentication-saml-oauth","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"userauthentication-saml-sso","createdAt":"2022-10-18T15:46:46.763Z","category":"61df6c48854879002316a70a","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"61df7c0b98653c0035502bb7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"GDPR & CCPA","type":"basic","slug":"gdpr-ccpa","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-13T01:10:35.406Z","category":"61df6c48854879002316a70a","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"62548949a3988b00275fe1d2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Security & SOC2 Reports","type":"link","slug":"soc2-security-room","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://trust.partnerstack.com/","link_external":true,"previousSlug":"","createdAt":"2022-04-11T20:02:17.256Z","category":"61df6c48854879002316a70a","parentDoc":null,"icon":"","isBodyEmpty":true,"children":[]}]},{"_id":"616d7496d993940010e714cc","title":"Testing Integrations","slug":"testing-integrations","order":11,"reference":false,"isAPI":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2021-10-18T13:20:22.577Z","__v":0,"pages":[{"_id":"616d74ec2263f70010f85d97","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Introduction to testing","type":"basic","slug":"introduction-testing","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction","createdAt":"2021-10-18T13:21:48.482Z","category":"616d7496d993940010e714cc","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"616d752062c2a403244f0156","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Creating Test Partner","type":"basic","slug":"creating-test-partner","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-18T13:22:40.920Z","category":"616d7496d993940010e714cc","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"616d75ac57a25900433b57ad","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Referral Link Flow","type":"basic","slug":"referral-link-flow","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-18T13:25:00.954Z","category":"616d7496d993940010e714cc","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"616d75fff4f88800292bce01","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Lead Submission Flow","type":"basic","slug":"lead-submission-flow","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-18T13:26:23.717Z","category":"616d7496d993940010e714cc","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"616d762f9727ee0035e8e337","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Deal Registration Flow","type":"basic","slug":"deal-registration-flow","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-18T13:27:11.744Z","category":"616d7496d993940010e714cc","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"616d76692f483800701df689","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Sending Test Transactions","type":"basic","slug":"sending-test-transactions","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-18T13:28:09.966Z","category":"616d7496d993940010e714cc","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"616d7692062a460016a5a734","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Rewards with Triggers","type":"basic","slug":"rewards-with-triggers","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-18T13:28:50.063Z","category":"616d7496d993940010e714cc","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"616d76b08f3e1b005eb3b811","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Next Steps","type":"basic","slug":"next-steps","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-18T13:29:20.521Z","category":"616d7496d993940010e714cc","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"600ef58ee2a122003d3c04cc","title":"Import","slug":"import","order":12,"reference":false,"isAPI":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2020-04-22T16:26:09.589Z","__v":0,"pages":[{"_id":"600ef58ee2a122003d3c0527","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Data Importer","type":"basic","slug":"universal-importer","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-21T21:16:45.853Z","category":"600ef58ee2a122003d3c04cc","parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"600ef58ee2a122003d3c04c3","project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","isAPI":false,"reference":false,"createdAt":"2017-06-16T01:43:46.540Z","from_sync":false,"order":13,"slug":"referral-widget","title":"Customer Referral Widget","__v":0,"pages":[{"_id":"600ef58ee2a122003d3c0530","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Referral iFrame","type":"basic","slug":"referral-iframe","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-06-03T15:30:39.893Z","category":"600ef58ee2a122003d3c04c3","parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"608aeba3174832005fbae500","title":"Authentication","slug":"authentication","order":15,"reference":true,"isAPI":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2021-04-29T17:23:47.757Z","__v":0,"pages":[{"_id":"608afb8c735fcd00460d047e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Partner API Authentication","type":"basic","slug":"partner-api-authentication","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-29T18:31:40.872Z","category":"608aeba3174832005fbae500","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"608aebdfa86d76002d83d5b8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Vendor API Authentication","type":"basic","slug":"auth","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-29T17:24:47.662Z","category":"608aeba3174832005fbae500","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"621e7f6553f3cf001a149273","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Base URL","type":"basic","slug":"base-url","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-03-01T20:17:41.650Z","category":"608aeba3174832005fbae500","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66c8a89f2b900d0010f2be31","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Rate Limits","icon":"","type":"basic","slug":"rate-limits","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"608aeba3174832005fbae500","createdAt":"2024-08-23T15:19:59.027Z","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"62be01225b452d0043fb57e9","title":"PartnerStack API","slug":"partnerstack-api-1","order":17,"reference":true,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2022-06-30T20:01:38.527Z","__v":0,"pages":[{"_id":"62be01255b452d0043fb57eb","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Deals","type":"basic","slug":"deals","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Deals","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.501Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"62be01265b452d0043fb580a","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Assign partnership to deal","type":"endpoint","slug":"post_deals-deal-key-assignment-partnership-key-stack-key-1","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_deals-deal-key-assignment-partnership-key-stack-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.737Z","parentDoc":"62be01255b452d0043fb57eb","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb580b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Get deal file","type":"endpoint","slug":"get_deals-deal-key-file-file-key-1","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_deals-deal-key-file-file-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.738Z","parentDoc":"62be01255b452d0043fb57eb","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6352adc6a08b11046d18ce2f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all deals","icon":"","type":"endpoint","slug":"get_v2-deals","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-deals","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:42.032Z","parentDoc":"62be01255b452d0043fb57eb","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6352adc6a08b11046d18ce30","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Create a deal","icon":"","type":"endpoint","slug":"post_v2-deals","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-deals","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:42.033Z","parentDoc":"62be01255b452d0043fb57eb","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6352adc6a08b11046d18ce31","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve the form templates for a deal","icon":"","type":"endpoint","slug":"get_v2-deals-form-templates","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-deals-form-templates","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:42.033Z","parentDoc":"62be01255b452d0043fb57eb","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6352adc6a08b11046d18ce32","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Archive a deal","icon":"","type":"endpoint","slug":"delete_v2-deals-deal-key","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v2-deals-deal-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:42.034Z","parentDoc":"62be01255b452d0043fb57eb","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6352adc6a08b11046d18ce33","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve a deal","icon":"","type":"endpoint","slug":"get_v2-deals-deal-key","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-deals-deal-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:42.035Z","parentDoc":"62be01255b452d0043fb57eb","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6352adc6a08b11046d18ce34","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Update a deal","icon":"","type":"endpoint","slug":"patch_v2-deals-deal-key","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v2-deals-deal-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:42.036Z","parentDoc":"62be01255b452d0043fb57eb","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6352adc6a08b11046d18ce35","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Convert a deal","icon":"","type":"endpoint","slug":"post_v2-deals-deal-key-convert","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-deals-deal-key-convert","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:42.037Z","parentDoc":"62be01255b452d0043fb57eb","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb581b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Get files attached to a deal","type":"endpoint","slug":"get_v2-deals-deal-key-files-1","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-deals-deal-key-files","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.749Z","parentDoc":"62be01255b452d0043fb57eb","icon":"","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62be01255b452d0043fb57ec","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Actions","type":"basic","slug":"actions-2","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Actions","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.502Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"62be01265b452d0043fb580c","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all actions","type":"endpoint","slug":"get_v2-actions-2","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-actions","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.738Z","parentDoc":"62be01255b452d0043fb57ec","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb580d","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Record action","type":"endpoint","slug":"post_v2-actions-1","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-actions","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.739Z","parentDoc":"62be01255b452d0043fb57ec","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb580e","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Archive an action","type":"endpoint","slug":"delete_v2-actions-action-key-1","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v2-actions-action-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.740Z","parentDoc":"62be01255b452d0043fb57ec","icon":"","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"6352adc5a08b11046d18ce2a","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8"},"title":"Applications","icon":"","type":"basic","slug":"applications","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Applications","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:41.736Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"65295920f59315000d058fba","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Create an Application","icon":"","type":"endpoint","slug":"post_v2-applications","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-applications","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-10-13T14:50:08.317Z","parentDoc":"6352adc5a08b11046d18ce2a","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6352adc6a08b11046d18ce2d","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Bulk Decision Applications","icon":"","type":"endpoint","slug":"patch_v2-applications-decision","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v2-applications-decision","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:42.028Z","parentDoc":"6352adc5a08b11046d18ce2a","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6352adc6a08b11046d18ce2e","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Decision an Application","icon":"","type":"endpoint","slug":"patch_v2-applications-application-key-decision","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v2-applications-application-key-decision","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-10-21T14:33:42.029Z","parentDoc":"6352adc5a08b11046d18ce2a","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62be01255b452d0043fb57ed","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Customers","type":"basic","slug":"customers-2","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Customers","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.502Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"62be01265b452d0043fb580f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all customers","type":"endpoint","slug":"get_v2-customers-2","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-customers","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.740Z","parentDoc":"62be01255b452d0043fb57ed","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb5810","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Create a customer","type":"endpoint","slug":"post_v2-customers-1","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-customers","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.741Z","parentDoc":"62be01255b452d0043fb57ed","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb5811","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Delete a customer","type":"endpoint","slug":"delete_v2-customers-customer-key-1","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v2-customers-customer-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.741Z","parentDoc":"62be01255b452d0043fb57ed","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6400d3af1b21a303ff476339","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve a customer","icon":"","type":"endpoint","slug":"get_v2-customers-customer-key","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-customers-customer-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-03-02T16:49:51.688Z","parentDoc":"62be01255b452d0043fb57ed","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb5813","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Update a customer","type":"endpoint","slug":"patch_v2-customers-customer-key-1","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v2-customers-customer-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.743Z","parentDoc":"62be01255b452d0043fb57ed","icon":"","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62be01255b452d0043fb57ee","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Form Templates","type":"basic","slug":"form-templates","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Form Templates","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.503Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"6400d3af1b21a303ff47633a","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all form templates","icon":"","type":"endpoint","slug":"get_v2-form-templates","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-form-templates","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-03-02T16:49:51.692Z","parentDoc":"62be01255b452d0043fb57ee","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62be01255b452d0043fb57ef","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Groups","type":"basic","slug":"groups","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Groups","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.503Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"636bc555398dd9002b4ccc8c","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all groups","icon":"","type":"endpoint","slug":"get_v2-groups","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-groups","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-09T15:20:53.322Z","parentDoc":"62be01255b452d0043fb57ef","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62be01255b452d0043fb57f0","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Leads","type":"basic","slug":"leads","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Leads","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.503Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"636bc555398dd9002b4ccc8d","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all leads","icon":"","type":"endpoint","slug":"get_v2-leads","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-leads","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-09T15:20:53.323Z","parentDoc":"62be01255b452d0043fb57f0","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"636bc555398dd9002b4ccc8e","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Create a lead","icon":"","type":"endpoint","slug":"post_v2-leads","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-leads","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-09T15:20:53.323Z","parentDoc":"62be01255b452d0043fb57f0","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"636bc555398dd9002b4ccc8f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve the form templates for a lead","icon":"","type":"endpoint","slug":"get_v2-leads-form-templates","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-leads-form-templates","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-09T15:20:53.324Z","parentDoc":"62be01255b452d0043fb57f0","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"636bc555398dd9002b4ccc90","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Archive a lead","icon":"","type":"endpoint","slug":"delete_v2-leads-lead-key","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v2-leads-lead-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-09T15:20:53.324Z","parentDoc":"62be01255b452d0043fb57f0","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"636bc555398dd9002b4ccc91","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve a lead","icon":"","type":"endpoint","slug":"get_v2-leads-lead-key","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-leads-lead-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-09T15:20:53.325Z","parentDoc":"62be01255b452d0043fb57f0","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"636bc555398dd9002b4ccc92","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Update a lead","icon":"","type":"endpoint","slug":"patch_v2-leads-lead-key","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v2-leads-lead-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-09T15:20:53.325Z","parentDoc":"62be01255b452d0043fb57f0","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"636bc555398dd9002b4ccc93","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Convert a lead","icon":"","type":"endpoint","slug":"post_v2-leads-lead-key-convert","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-leads-lead-key-convert","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-09T15:20:53.326Z","parentDoc":"62be01255b452d0043fb57f0","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"67239c629dd41d003b3f000b","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8"},"title":"Links","icon":"","type":"basic","slug":"links","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Links","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2024-10-31T15:04:02.637Z","isBodyEmpty":true,"children":[{"_id":"67239c629dd41d003b3f000d","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all links","icon":"","type":"endpoint","slug":"get_v2-links-partnership-identifier","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-links-partnership-identifier","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2024-10-31T15:04:02.945Z","parentDoc":"67239c629dd41d003b3f000b","isBodyEmpty":true,"children":[]}]},{"_id":"6491bb2fbcd093000ad69c79","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8"},"title":"Partner Team","icon":"","type":"basic","slug":"partner-team","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Partner Team","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-06-20T14:43:59.946Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"6491bb30bcd093000ad69c7b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve a partner team","icon":"","type":"endpoint","slug":"get_v2-partner-team-team-key","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-partner-team-team-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-06-20T14:44:00.432Z","parentDoc":"6491bb2fbcd093000ad69c79","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62be01255b452d0043fb57f1","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Partnerships","type":"basic","slug":"partnerships","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Partnerships","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.504Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"62be01265b452d0043fb5825","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all partnerships","type":"endpoint","slug":"get_v2-partnerships-2","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-partnerships","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.756Z","parentDoc":"62be01255b452d0043fb57f1","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6478fc8c1abe050026305e12","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Update partnerships","icon":"","type":"endpoint","slug":"patch_v2-partnerships","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v2-partnerships","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-06-01T20:16:12.451Z","parentDoc":"62be01255b452d0043fb57f1","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"636bc555398dd9002b4ccc94","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Create a partnership","icon":"","type":"endpoint","slug":"post_v2-partnerships","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-partnerships","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-09T15:20:53.328Z","parentDoc":"62be01255b452d0043fb57f1","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb5827","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Archive a partnership","type":"endpoint","slug":"delete_v2-partnerships-partnership-key","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v2-partnerships-partnership-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.758Z","parentDoc":"62be01255b452d0043fb57f1","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb5829","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Update a partnership","type":"endpoint","slug":"patch_v2-partnerships-partnership-key","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v2-partnerships-partnership-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.765Z","parentDoc":"62be01255b452d0043fb57f1","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb582a","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Updates a partnership's tags","type":"endpoint","slug":"patch_v2-partnerships-partnership-key-tags","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v2-partnerships-partnership-key-tags","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.765Z","parentDoc":"62be01255b452d0043fb57f1","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"6470c464738b570017650ef3","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve a partnership","icon":"","type":"endpoint","slug":"get_v2-partnerships-unique-identifier","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-partnerships-unique-identifier","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-05-26T14:38:28.994Z","parentDoc":"62be01255b452d0043fb57f1","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62be01255b452d0043fb57f2","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Rewards","type":"basic","slug":"rewards","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Rewards","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.504Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"62be01265b452d0043fb582b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all rewards","type":"endpoint","slug":"get_v2-rewards-2","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-rewards","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.766Z","parentDoc":"62be01255b452d0043fb57f2","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb582c","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Create a reward","type":"endpoint","slug":"post_v2-rewards","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-rewards","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.767Z","parentDoc":"62be01255b452d0043fb57f2","icon":"","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"651195522f57931600c5cc0e","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8"},"title":"SalesCycles","icon":"","type":"basic","slug":"salescycles","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__SalesCycles","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-09-25T14:12:34.387Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"6464ce4605f44f148d98391c","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve Sales Cycle Stages","icon":"","type":"endpoint","slug":"get_v2-sales-cycles-object-type-stages","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-sales-cycles-object-type-stages","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-05-17T12:53:26.078Z","parentDoc":"651195522f57931600c5cc0e","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"62be01255b452d0043fb57f3","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Transactions","type":"basic","slug":"transactions-2","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Transactions","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.505Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"62be01265b452d0043fb582d","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all transactions","type":"endpoint","slug":"get_v2-transactions-2","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-transactions","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.768Z","parentDoc":"62be01255b452d0043fb57f3","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62be01265b452d0043fb582e","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Create a transaction","type":"endpoint","slug":"post_v2-transactions","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-transactions","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:42.769Z","parentDoc":"62be01255b452d0043fb57f3","icon":"","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"62fbf7e77b9e37007e209371","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Transaction Metadata","icon":"","type":"basic","slug":"transaction-metadata","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-08-16T20:02:47.319Z","category":"62be01225b452d0043fb57e9","parentDoc":"62be01255b452d0043fb57f3","isBodyEmpty":false,"children":[]},{"_id":"646e52bbd1b73d001b18a71b","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Delete a transaction","icon":"","type":"endpoint","slug":"delete_v2-transactions-transaction-key","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v2-transactions-transaction-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2023-05-24T18:08:59.913Z","parentDoc":"62be01255b452d0043fb57f3","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"66fff1f07bb70f005d4cc6f3","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8"},"title":"Stats","icon":"","type":"basic","slug":"stats","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Stats","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2024-10-04T13:47:28.632Z","isBodyEmpty":true,"children":[{"_id":"66fff1f07bb70f005d4cc6f9","mdx":{},"api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"POST - Export the current results of a custom report","icon":"","type":"endpoint","slug":"post_v2-vendor-report-export-vendor-report-configuration-key","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-vendor-report-export-vendor-report-configuration-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2024-10-04T13:47:28.826Z","parentDoc":"66fff1f07bb70f005d4cc6f3","isBodyEmpty":true,"children":[]},{"_id":"66fff1f07bb70f005d4cc6fa","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all custom reports","icon":"","type":"endpoint","slug":"get_vendor-report-configuration-list-company-company-key","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_vendor-report-configuration-list-company-company-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2024-10-04T13:47:28.827Z","parentDoc":"66fff1f07bb70f005d4cc6f3","isBodyEmpty":true,"children":[]},{"_id":"66fff1f07bb70f005d4cc6fb","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve a custom report","icon":"","type":"endpoint","slug":"get_vendor-report-configuration-vendor-report-configuration-key","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_vendor-report-configuration-vendor-report-configuration-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2024-10-04T13:47:28.827Z","parentDoc":"66fff1f07bb70f005d4cc6f3","isBodyEmpty":true,"children":[]}]},{"_id":"62be01255b452d0043fb57f4","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"62be01225b452d0043fb57e8","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Webhooks","type":"basic","slug":"webhooks","order":14,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Webhooks","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-06-30T20:01:41.505Z","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"639a391953f67a002a979791","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"List all webhooks","icon":"","type":"endpoint","slug":"get_v2-webhooks","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-webhooks","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-12-14T20:59:05.655Z","parentDoc":"62be01255b452d0043fb57f4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"638664a33f693c0017e53cc2","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Create a webhook","icon":"","type":"endpoint","slug":"post_v2-webhooks","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v2-webhooks","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-11-29T19:59:31.477Z","parentDoc":"62be01255b452d0043fb57f4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"639a391953f67a002a979792","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Archive a webhook","icon":"","type":"endpoint","slug":"delete_v2-webhooks-webhook-key","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v2-webhooks-webhook-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-12-14T20:59:05.657Z","parentDoc":"62be01255b452d0043fb57f4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"639a391953f67a002a979793","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Retrieve a webhook","icon":"","type":"endpoint","slug":"get_v2-webhooks-webhook-key","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-webhooks-webhook-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-12-14T20:59:05.657Z","parentDoc":"62be01255b452d0043fb57f4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"639a391953f67a002a979794","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"62be01225b452d0043fb57e8"},"title":"Update a webhook","icon":"","type":"endpoint","slug":"patch_v2-webhooks-webhook-key","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v2-webhooks-webhook-key","link_url":"","link_external":false,"previousSlug":"","category":"62be01225b452d0043fb57e9","createdAt":"2022-12-14T20:59:05.658Z","parentDoc":"62be01255b452d0043fb57f4","mdx":{},"isBodyEmpty":true,"children":[]}]}]},{"_id":"6089968aa9c8bb031178ab08","title":"PartnerStack Partner API","slug":"partnerstack-partner-api","order":18,"reference":true,"isAPI":true,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","createdAt":"2021-04-28T17:08:26.941Z","__v":0,"pages":[{"_id":"61031f9772245903fa5ea788","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6089968aa9c8bb031178ab07"},"title":"Actions","type":"basic","slug":"actions-1","order":0,"isReference":true,"hidden":false,"sync_unique":"tag__Actions","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-07-29T21:37:27.562Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"61031f9872245903fa5ea78e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6089968aa9c8bb031178ab07"},"title":"List all actions","type":"endpoint","slug":"get_v2-actions","order":0,"isReference":true,"hidden":false,"sync_unique":"get_v2-actions","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-07-29T21:37:28.108Z","parentDoc":"61031f9772245903fa5ea788","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"61031f9772245903fa5ea789","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6089968aa9c8bb031178ab07"},"title":"Customers","type":"basic","slug":"customers","order":1,"isReference":true,"hidden":false,"sync_unique":"tag__Customers","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-07-29T21:37:27.564Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"61031f9872245903fa5ea78f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6089968aa9c8bb031178ab07"},"title":"List all customers","type":"endpoint","slug":"get_v2-customers-1","order":0,"isReference":true,"hidden":false,"sync_unique":"get_v2-customers","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-07-29T21:37:28.110Z","parentDoc":"61031f9772245903fa5ea789","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"65f2042adeb3bd006aab04e4","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6089968aa9c8bb031178ab07"},"title":"Marketplace","icon":"","type":"basic","slug":"marketplace","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__Marketplace","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2024-03-13T19:53:14.594Z","parentDoc":null,"mdx":{},"isBodyEmpty":true,"children":[{"_id":"65f2042adeb3bd006aab04e6","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6089968aa9c8bb031178ab07"},"title":"List all programs","icon":"","type":"endpoint","slug":"get_v2-marketplace-programs","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-marketplace-programs","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2024-03-13T19:53:14.702Z","parentDoc":"65f2042adeb3bd006aab04e4","mdx":{},"isBodyEmpty":true,"children":[]},{"_id":"65f2042adeb3bd006aab04e7","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6089968aa9c8bb031178ab07"},"title":"Retrieve a marketplace program","icon":"","type":"endpoint","slug":"get_v2-marketplace-programs-company-key","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v2-marketplace-programs-company-key","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2024-03-13T19:53:14.703Z","parentDoc":"65f2042adeb3bd006aab04e4","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"6089968ca9c8bb031178ab09","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6089968aa9c8bb031178ab07"},"title":"Partnerships","type":"basic","slug":"partnerships-1","order":3,"isReference":true,"hidden":false,"sync_unique":"tag__Partnerships","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-04-28T17:08:28.483Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"6089968da9c8bb031178ab0f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6089968aa9c8bb031178ab07"},"title":"List all partnerships","type":"endpoint","slug":"get_v2-partnerships","order":0,"isReference":true,"hidden":false,"sync_unique":"get_v2-partnerships","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-04-28T17:08:29.009Z","parentDoc":"6089968ca9c8bb031178ab09","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"611418b8e848e4005c92bb11","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6089968aa9c8bb031178ab07"},"title":"Payouts","type":"basic","slug":"payouts","order":4,"isReference":true,"hidden":false,"sync_unique":"tag__Payouts","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-08-11T18:36:40.941Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"610c4afc2dab6b003096ca95","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6089968aa9c8bb031178ab07"},"title":"List all payouts","type":"endpoint","slug":"get_v2-payouts","order":0,"isReference":true,"hidden":false,"sync_unique":"get_v2-payouts","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-08-05T20:33:00.226Z","parentDoc":"611418b8e848e4005c92bb11","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[]}]},{"_id":"6089968ca9c8bb031178ab0a","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6089968aa9c8bb031178ab07"},"title":"Rewards","type":"basic","slug":"rewards-1","order":5,"isReference":true,"hidden":false,"sync_unique":"tag__Rewards","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-04-28T17:08:28.484Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"6089968da9c8bb031178ab10","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6089968aa9c8bb031178ab07"},"title":"List all rewards","type":"endpoint","slug":"get_v2-rewards","order":0,"isReference":true,"hidden":false,"sync_unique":"get_v2-rewards","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-04-28T17:08:29.010Z","parentDoc":"6089968ca9c8bb031178ab0a","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]}]},{"_id":"610305e6eb2a40038c44f46f","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"6089968aa9c8bb031178ab07"},"title":"Transactions","type":"basic","slug":"transactions","order":6,"isReference":true,"hidden":false,"sync_unique":"tag__Transactions","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-07-29T19:47:50.681Z","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":true,"children":[{"_id":"610305e6eb2a40038c44f472","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"6089968aa9c8bb031178ab07"},"title":"List all transactions","type":"endpoint","slug":"get_v2-transactions","order":0,"isReference":true,"hidden":false,"sync_unique":"get_v2-transactions","link_url":"","link_external":false,"previousSlug":"","category":"6089968aa9c8bb031178ab08","createdAt":"2021-07-29T19:47:50.915Z","parentDoc":"610305e6eb2a40038c44f46f","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]}]}]}]},"apiBaseUrl":"/","baseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"Y2JiNGM3N2I1MDI1ZWQxZWI5ZjZkMjIzMjViOTU5YzU2MzU3OWU3NTgyYmQ0Y2E4ODI4ZDhjYzdlNzVhMTEyYXRhZ0ZpbHRlcnM9KHByb2plY3Q6NTU2ZTJjYTBjOWQ4NWExOTAwOTE0ZDI4KSwodmVyc2lvbjpub25lLHZlcnNpb246NjAwZWY1OGVlMmExMjIwMDNkM2MwNTU5KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","indexName":"readme_search_v2","projectsMeta":[{"modules":{"examples":true,"landing":true,"reference":true,"suggested_edits":true,"discuss":false,"docs":true,"logs":false,"changelog":false,"custompages":false,"tutorials":false,"graphql":false},"id":"556e2ca0c9d85a1900914d28","name":"PartnerStack","subdomain":"partnerstack","subpath":"","nav_names":{"discuss":"Community Discussion","docs":"Guides","reference":"API Reference","changelog":"Releases","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"partnerstack"},"version":"2.0"}},"activeDoc":"getting-started","rdmd":{"baseUrl":"/","body":"PartnerStack helps partnership teams easily scale their program revenue by automating a variety of partner referral and sales motions in a single dashboard.\n\nPartnerStack makes it simple to manage your partner onboarding and training, ongoing partner engagement, as well as revenue, sales, and commissions payments.\n\nThe features of PartnerStack are tightly coupled with integrations that easily connect your partner channel with your core business sales, support, and billing tools. \n\nPartnerStack connects to key events in your business to:\n * automate partner attribution\n * transparently communicate sales pipeline between partners and your internal CRM\n * report on partner performance\n \nIf you're new to PartnerStack or partnerships, this short 5-minute overview video introduces you to the core concepts within PartnerStack.\n\n[block:embed]\n{\n \"html\": \"<iframe class=\\\"embedly-embed\\\" src=\\\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Ffast.wistia.net%2Fembed%2Fiframe%2F7i8ihq2fy6&display_name=Wistia%2C+Inc.&url=https%3A%2F%2Fpartnerstack.wistia.com%2Fmedias%2F7i8ihq2fy6&image=https%3A%2F%2Fembed-ssl.wistia.com%2Fdeliveries%2F62602a3143e256e9cdccdaf522cf10350adc287c.jpg%3Fimage_crop_resized%3D960x540&key=f2aa6fc3595946d0afc3d76cbbd25dc3&type=text%2Fhtml&schema=wistia\\\" width=\\\"960\\\" height=\\\"540\\\" scrolling=\\\"no\\\" title=\\\"Wistia, Inc. embed\\\" frameborder=\\\"0\\\" allow=\\\"autoplay; fullscreen\\\" allowfullscreen=\\\"true\\\"></iframe>\",\n \"url\": \"https://partnerstack.wistia.com/medias/7i8ihq2fy6\",\n \"title\": \"PartnerStack 5-minute demo video (ungated)\",\n \"favicon\": \"https://partnerstack.wistia.com/favicon.ico\",\n \"image\": \"https://embed-ssl.wistia.com/deliveries/62602a3143e256e9cdccdaf522cf10350adc287c.jpg?image_crop_resized=960x540\"\n}\n[/block]","dehydrated":{"toc":"","body":"<p>PartnerStack helps partnership teams easily scale their program revenue by automating a variety of partner referral and sales motions in a single dashboard.</p>\n<p>PartnerStack makes it simple to manage your partner onboarding and training, ongoing partner engagement, as well as revenue, sales, and commissions payments.</p>\n<p>The features of PartnerStack are tightly coupled with integrations that easily connect your partner channel with your core business sales, support, and billing tools. </p>\n<p>PartnerStack connects to key events in your business to:</p>\n<ul>\n<li>automate partner attribution</li>\n<li>transparently communicate sales pipeline between partners and your internal CRM</li>\n<li>report on partner performance</li>\n</ul>\n<p>If you&#x27;re new to PartnerStack or partnerships, this short 5-minute overview video introduces you to the core concepts within PartnerStack.</p>\n<div class=\"embed embed_hasImg\"><div class=\"embed-media\"><iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Ffast.wistia.net%2Fembed%2Fiframe%2F7i8ihq2fy6&display_name=Wistia%2C+Inc.&url=https%3A%2F%2Fpartnerstack.wistia.com%2Fmedias%2F7i8ihq2fy6&image=https%3A%2F%2Fembed-ssl.wistia.com%2Fdeliveries%2F62602a3143e256e9cdccdaf522cf10350adc287c.jpg%3Fimage_crop_resized%3D960x540&key=f2aa6fc3595946d0afc3d76cbbd25dc3&type=text%2Fhtml&schema=wistia\" width=\"960\" height=\"540\" scrolling=\"no\" title=\"Wistia, Inc. embed\" frameborder=\"0\" allow=\"autoplay; fullscreen\" allowfullscreen=\"true\"></iframe></div></div>"},"mdx":false,"opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{}},"safeMode":false,"settings":{"position":true},"theme":"light","customBlocks":{},"resourceID":"600ef58ee2a122003d3c04d1","resourceType":"page","baseUrl":"/","terms":[],"variables":{"user":{},"defaults":[{"source":"security","_id":"62fd5a29c9fc4f006fd7aad9","name":"basicAuth","type":"http","scheme":"basic","apiSetting":"60899bb80da3bf00162f61ec"},{"source":"security","_id":"671ba533f6d281005a2d7e7a","name":"bearerAuth","type":"http","scheme":"bearer","apiSetting":"6089968aa9c8bb031178ab07"}]}},"terms":[],"variables":{"user":{},"defaults":[{"source":"security","_id":"62fd5a29c9fc4f006fd7aad9","name":"basicAuth","type":"http","scheme":"basic","apiSetting":"60899bb80da3bf00162f61ec"},{"source":"security","_id":"671ba533f6d281005a2d7e7a","name":"bearerAuth","type":"http","scheme":"bearer","apiSetting":"6089968aa9c8bb031178ab07"}]}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":""},"next":{"description":"Begin your implementation plan by learning about PartnerStack objects and the partnership industry","pages":[{"type":"doc","icon":"file-text-o","name":"Planning your implementation","slug":"plan-your-implementation","category":"Getting Started"}]},"algolia":{"recordCount":1,"publishPending":false,"translationFailure":false,"updatedAt":"2024-10-25T14:03:34.737Z"},"title":"What is PartnerStack?","icon":"","updates":["580e20187d266c1b006fca92","5d1e12acf50ecd01d0d0e8e0"],"type":"basic","slug":"getting-started","excerpt":"","body":"PartnerStack helps partnership teams easily scale their program revenue by automating a variety of partner referral and sales motions in a single dashboard.\n\nPartnerStack makes it simple to manage your partner onboarding and training, ongoing partner engagement, as well as revenue, sales, and commissions payments.\n\nThe features of PartnerStack are tightly coupled with integrations that easily connect your partner channel with your core business sales, support, and billing tools. \n\nPartnerStack connects to key events in your business to:\n * automate partner attribution\n * transparently communicate sales pipeline between partners and your internal CRM\n * report on partner performance\n \nIf you're new to PartnerStack or partnerships, this short 5-minute overview video introduces you to the core concepts within PartnerStack.\n\n[block:embed]\n{\n \"html\": \"<iframe class=\\\"embedly-embed\\\" src=\\\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Ffast.wistia.net%2Fembed%2Fiframe%2F7i8ihq2fy6&display_name=Wistia%2C+Inc.&url=https%3A%2F%2Fpartnerstack.wistia.com%2Fmedias%2F7i8ihq2fy6&image=https%3A%2F%2Fembed-ssl.wistia.com%2Fdeliveries%2F62602a3143e256e9cdccdaf522cf10350adc287c.jpg%3Fimage_crop_resized%3D960x540&key=f2aa6fc3595946d0afc3d76cbbd25dc3&type=text%2Fhtml&schema=wistia\\\" width=\\\"960\\\" height=\\\"540\\\" scrolling=\\\"no\\\" title=\\\"Wistia, Inc. embed\\\" frameborder=\\\"0\\\" allow=\\\"autoplay; fullscreen\\\" allowfullscreen=\\\"true\\\"></iframe>\",\n \"url\": \"https://partnerstack.wistia.com/medias/7i8ihq2fy6\",\n \"title\": \"PartnerStack 5-minute demo video (ungated)\",\n \"favicon\": \"https://partnerstack.wistia.com/favicon.ico\",\n \"image\": \"https://embed-ssl.wistia.com/deliveries/62602a3143e256e9cdccdaf522cf10350adc287c.jpg?image_crop_resized=960x540\"\n}\n[/block]","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"","slugUpdatedAt":"2021-02-26T01:05:39.938Z","revision":9,"_id":"600ef58ee2a122003d3c04d1","__v":8,"category":{"title":"Getting Started","slug":"guides","order":0,"reference":false,"_id":"600ef58ee2a122003d3c04be","__v":0,"sync":{"url":"","isSync":false},"createdAt":"2016-09-11T18:31:48.146Z","from_sync":false,"project":"556e2ca0c9d85a1900914d28","version":"600ef58ee2a122003d3c0559","isAPI":false,"type":"guide","id":"600ef58ee2a122003d3c04be"},"parentDoc":null,"project":"556e2ca0c9d85a1900914d28","user":"6006ee50a38f640201cf1891","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["556e2ca1c9d85a1900914d2c","57c882d89e6bca0e007edecb","600ef58ee2a122003d3c04bd","57d58dce17b492170053a3fc","57d59a0465a96a170037d0e9","57d59a35b0249a0e002bba04","57d5a0a3e2e70e20009cda30","600ef58ee2a122003d3c04be","600ef58ee2a122003d3c04bf","600ef58ee2a122003d3c04c0","58d14a1cfca38f1b00f7a177","590211faa244811900a7ac33","600ef58ee2a122003d3c04c1","600ef58ee2a122003d3c04c2","600ef58ee2a122003d3c04c3","600ef58ee2a122003d3c04c4","600ef58ee2a122003d3c04c5","600ef58ee2a122003d3c04c6","5963875ea3b85d001b60e9ba","600ef58ee2a122003d3c04c7","59d2a7d671eb380010282dfa","59d2a804610da1003c9e101f","600ef58ee2a122003d3c04c8","5accc3565093160003ea6144","600ef58ee2a122003d3c04c9","600ef58ee2a122003d3c04ca","5b96b2ae40d30c0003f22483","600ef58ee2a122003d3c04cb","5b9829adf807610003ff9645","5bdc662159aea40023bbe834","5c803fafed2d7e002d0c13b5","5dd83bf6750b24039c954fe4","5ddc023a8035950056c5ffb2","5de56b3cf93f2802705ed6f8","5de56f5ad0f89d003c089ef7","5de56fbb9b1b0e0316ea4896","5de57b7562ca2502a2cb37f6","5de5898ace84aa002bad88de","5de589f1f15cfa0380010a09","5de58a1290252f02d800bd23","5de68435202414007399b6c3","5de7f2cc522a8b002f395cfb","5de7f314a0cdc801b4a290bd","5de80341162de4001313d266","5de803fb0427ff005e827a47","5de8044d162de4001313d289","5de90e971817ee0072b1c09a","5defe166b711d800208f831b","5defe44353ee080024b068fa","5e21f2d6f1748c0048dcace1","5e29c9a6ee2a9600517f71ee","605bf12d01db370016cb3bfd","6089968aa9c8bb031178ab08","60899bb80da3bf00162f61ed","608aeba3174832005fbae500","61280504415308001182b364","616d7496d993940010e714cc","61df6c48854879002316a70a","61df6fe49fc45102c5b6f335","61df7047771c4e001631dede","61df79098186e601ed11b96d","61df8228ebe3e600170aaca8","61e44408d45a39002a020084","61e48f9613b4d00016050de8","621e7f413b032a00302b5d30","62a794a08db2710079153dc0","62a795262cc5e3009968e357","62be01225b452d0043fb57e9","6320aa968f0edb0038f3d01c","6363dc28fdf3b700101a9006","6376b43c081e400003bad2c7","63caffe61fc0a40017369ff1","63cb00011109090010d32caa","63cb004a8d17f000317f2aba","63cb0098916166005f64e5cc","63cb00cfa13a7600918ab7d9","63cb00f78d17f000317f3420","63d3ec4cfb028e00a603f6aa","6410e175294936005f555608"],"pdfStatus":"","source":"readme","_id":"600ef58ee2a122003d3c0559","__v":0,"createdAt":"2015-06-02T22:22:25.207Z","project":"556e2ca0c9d85a1900914d28","releaseDate":"2015-06-02T22:22:25.207Z","forked_from":"556e2ca1c9d85a1900914d2b","apiRegistries":[]},"githubsync":"","createdAt":"2015-06-02T22:22:26.497Z","updatedAt":"2023-12-11T17:03:36.563Z","pendingAlgoliaPublish":false,"lastUpdatedHash":"93e742ebaa97ca4506b49fa49e46be6e01d2daa1","isApi":false,"tutorials":[],"id":"600ef58ee2a122003d3c04d1"},"hideTOC":false,"meta":{"_id":"600ef58ee2a122003d3c04d1","description":"PartnerStack helps partnership teams easily scale their program revenue by automating a variety of partner referral and sales motions in a single dashboard. PartnerStack makes it simple to manage your partner onboarding and training, ongoing partner engagement, as well as revenue, sales, and commiss...","hidden":false,"image":[],"keywords":"","metaTitle":"What is PartnerStack?","parent":null,"robots":"index","slug":"getting-started","title":"What is PartnerStack?","type":"docs"},"slugUrl":"/docs/getting-started","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.322.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[],"variables":{"user":{},"defaults":[{"source":"security","_id":"62fd5a29c9fc4f006fd7aad9","name":"basicAuth","type":"http","scheme":"basic","apiSetting":"60899bb80da3bf00162f61ec"},{"source":"security","_id":"671ba533f6d281005a2d7e7a","name":"bearerAuth","type":"http","scheme":"bearer","apiSetting":"6089968aa9c8bb031178ab07"}]},"project":{"_id":"556e2ca0c9d85a1900914d28","appearance":{"html_hidelinks":false,"logo_white_use":false,"promos":[{"extras":{"type":"search","buttonPrimary":"get-started","buttonSecondary":"docs"},"title":"Welcome to the PartnerStack Docs","text":"Explore our guides and examples to integrate with PartnerStack","_id":"556e2ca0c9d85a1900914d29"}],"html_head":"","javascript_hub2":"","link_logo_to_url":false,"overlay":"triangles","typography":{"body":"Open+Sans:400:sans-serif","headline":"Open+Sans:400:sans-serif","tk_body":"proxima-nova","tk_headline":"proxima-nova","tk_key":"rnd8okf","typekit":true},"hide_logo":true,"html_body":"","html_footer_meta":"","html_promo":"","stylesheet":"h2{\n text-transform: none !important;\n}","theme":"line","landing":true,"body":{"style":"overlap"},"showVersion":true,"colors":{"body_highlight":"#434de1","header_text":"","highlight":"","main":"#434de1","main_alt":"#b8cedc","custom_login_link_color":""},"notheme":false,"stylesheet_hub2":"p {color: #555;}\n\n/* Added as fix for ReadMe UI expand toggle bug */\nli.subnav-expanded.subnav-soft-toggle > a.text-wrap {\n color: #fff !important;\n}\n\nli.subnav-expanded.hub-sidebar-page > a.text-wrap {\n color: #fff !important;\n}\n\n/* Inline-code on response schema */\ndiv.response-schema code.rdmd-code {\n background: rgb(255 255 255 / 10%) !important;\n color: #fff !important;\n}","favicon":["https://files.readme.io/e7ba444-small-PartnerStack-logo-pack-2022_Icon-only_Full-color.png","PartnerStack-logo-pack-2022_Icon-only (Full-color).png",30,32,"#4b55cb","https://files.readme.io/76ce44f-PartnerStack-logo-pack-2022_Icon-only_Full-color.png"],"html_footer":"","logo":["https://files.readme.io/ca13b47-small-PartnerStack-logo-pack-2022_Primary_Logo_Horizontal_Full-color.png","PartnerStack-logo-pack-2022_Primary Logo (Horizontal Full-color).png",234,80,"#262d94","https://files.readme.io/79162e3-PartnerStack-logo-pack-2022_Primary_Logo_Horizontal_Full-color.png"],"logo_white":["https://files.readme.io/a624125-small-PartnerStack-logo-pack-2022_Logo_Horizontal_White.png","PartnerStack-logo-pack-2022_Logo (Horizontal White).png",234,80,"#ffffff","https://files.readme.io/c743406-PartnerStack-logo-pack-2022_Logo_Horizontal_White.png"],"main_body":{"type":"all-docs"},"sticky":true,"header":{"img":["https://files.readme.io/fc355d8-Green_Banner.png","Green Banner.png",3640,1000,"#4bb373"],"img_pos":"tl","img_size":"cover","style":"overlay"},"javascript":"","hideTableOfContents":false,"referenceLayout":"column","childrenAsPills":false,"global_landing_page":{"html":"","redirect":""},"nextStepsLabel":"What's next...","splitReferenceDocs":false,"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"subheaderStyle":"links","showMetricsInReference":true,"referenceSimpleMode":false,"stylesheet_hub3":"","loginLogo":[],"logo_large":false,"colorScheme":"light","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"docs.partnerstack.com","childrenProjects":[],"derivedPlan":"business2018","description":"PartnerStack connects to key events in your business to automatically incentivize and reward partners like resellers, consultants, and ambassadors.\n\nBy fingerprinting traffic from your partners, PartnerStack's technology identifies and rewards the people and organizations growing your business.","error404":"","experiments":[],"first_page":"landing","flags":{"allow_hub2":false,"autoSslGeneration":true,"correctnewlines":false,"hub2":true,"jwt":false,"allowXFrame":false,"migrationRun":true,"migrationSwaggerRun":true,"oauth":false,"speedyRender":false,"ssl":false,"swagger":false,"newApiExplorer":true,"alwaysShowDocPublishStatus":false,"cookieAuthentication":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"hideGoogleAnalytics":false,"newEditor":true,"newMarkdown":false,"translation":false,"newMarkdownBetaProgram":true,"oldMarkdown":false,"newSearch":true,"rdmdCompatibilityMode":false,"tutorials":true,"allowApiExplorerJsonEditor":false,"staging":false,"useReactApp":true,"newHeader":false,"referenceRedesign":false,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":false,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":false,"superHubGlobalCustomBlocks":false,"childManagedBidi":false},"fullBaseUrl":"https://docs.partnerstack.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"glossaryTerms":[],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"docs","alignment":"left","pageType":"Documentation"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"examples":true,"landing":true,"reference":true,"suggested_edits":true,"discuss":false,"docs":true,"logs":false,"changelog":false,"custompages":false,"tutorials":false,"graphql":false},"name":"PartnerStack","nav_names":{"discuss":"Community Discussion","docs":"Guides","reference":"API Reference","changelog":"Releases","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":true,"api":true,"logs":true,"domain":true,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"business2018","planOverride":"business2018","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"business2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":true,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":50,"totalScore":174},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"600ef58ee2a122003d3c0559","version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["556e2ca1c9d85a1900914d2c","57c882d89e6bca0e007edecb","600ef58ee2a122003d3c04bd","57d58dce17b492170053a3fc","57d59a0465a96a170037d0e9","57d59a35b0249a0e002bba04","57d5a0a3e2e70e20009cda30","600ef58ee2a122003d3c04be","600ef58ee2a122003d3c04bf","600ef58ee2a122003d3c04c0","58d14a1cfca38f1b00f7a177","590211faa244811900a7ac33","600ef58ee2a122003d3c04c1","600ef58ee2a122003d3c04c2","600ef58ee2a122003d3c04c3","600ef58ee2a122003d3c04c4","600ef58ee2a122003d3c04c5","600ef58ee2a122003d3c04c6","5963875ea3b85d001b60e9ba","600ef58ee2a122003d3c04c7","59d2a7d671eb380010282dfa","59d2a804610da1003c9e101f","600ef58ee2a122003d3c04c8","5accc3565093160003ea6144","600ef58ee2a122003d3c04c9","600ef58ee2a122003d3c04ca","5b96b2ae40d30c0003f22483","600ef58ee2a122003d3c04cb","5b9829adf807610003ff9645","5bdc662159aea40023bbe834","5c803fafed2d7e002d0c13b5","5dd83bf6750b24039c954fe4","5ddc023a8035950056c5ffb2","5de56b3cf93f2802705ed6f8","5de56f5ad0f89d003c089ef7","5de56fbb9b1b0e0316ea4896","5de57b7562ca2502a2cb37f6","5de5898ace84aa002bad88de","5de589f1f15cfa0380010a09","5de58a1290252f02d800bd23","5de68435202414007399b6c3","5de7f2cc522a8b002f395cfb","5de7f314a0cdc801b4a290bd","5de80341162de4001313d266","5de803fb0427ff005e827a47","5de8044d162de4001313d289","5de90e971817ee0072b1c09a","5defe166b711d800208f831b","5defe44353ee080024b068fa","5e21f2d6f1748c0048dcace1","5e29c9a6ee2a9600517f71ee","605bf12d01db370016cb3bfd","6089968aa9c8bb031178ab08","60899bb80da3bf00162f61ed","608aeba3174832005fbae500","61280504415308001182b364","616d7496d993940010e714cc","61df6c48854879002316a70a","61df6fe49fc45102c5b6f335","61df7047771c4e001631dede","61df79098186e601ed11b96d","61df8228ebe3e600170aaca8","61e44408d45a39002a020084","61e48f9613b4d00016050de8","621e7f413b032a00302b5d30","62a794a08db2710079153dc0","62a795262cc5e3009968e357","62be01225b452d0043fb57e9","6320aa968f0edb0038f3d01c","6363dc28fdf3b700101a9006","6376b43c081e400003bad2c7","63caffe61fc0a40017369ff1","63cb00011109090010d32caa","63cb004a8d17f000317f2aba","63cb0098916166005f64e5cc","63cb00cfa13a7600918ab7d9","63cb00f78d17f000317f3420","63d3ec4cfb028e00a603f6aa","6410e175294936005f555608"],"__v":0,"createdAt":"2015-06-02T22:22:25.207Z","project":"556e2ca0c9d85a1900914d28","releaseDate":"2015-06-02T22:22:25.207Z","forked_from":"556e2ca1c9d85a1900914d2b"},"subdomain":"partnerstack","subpath":"","superHubWaitlist":false,"topnav":{"edited":true,"left":[{"type":"docs","text":"Guides"},{"type":"reference","text":"API Reference"}],"right":[{"type":"url","text":"Support","url":"https://support.partnerstack.com/hc/en-us"},{"type":"url","text":"PartnerStack Login","url":"https://dash.partnerstack.com"}],"bottom":[]},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2024-05-29T18:36:52.363Z"},"translate":{"languages":[],"provider":"transifex","key_public":"","org_name":"","project_name":"","show_widget":false},"url":"https://partnerstack.com","versions":[{"_id":"556e2ca1c9d85a1900914d2b","__v":52,"is_beta":false,"is_hidden":false,"version":"1.0","categories":["556e2ca1c9d85a1900914d2c","57c882d89e6bca0e007edecb","57d1c2855284c90e00cc0683","57d58dce17b492170053a3fc","57d59a0465a96a170037d0e9","57d59a35b0249a0e002bba04","57d5a0a3e2e70e20009cda30","57d5a3148191880e008bb548","57d5a36b8191880e008bb549","57d5a3718191880e008bb54a","58d14a1cfca38f1b00f7a177","590211faa244811900a7ac33","5943247985ef33000ff3af97","5943368ea9b3f1000f38e423","594337d25201ea000fb231a4","59433826a9b3f1000f38e4e7","594425c14e65c30019d8c43f","5949432931fdf80010e4159b","5963875ea3b85d001b60e9ba","59a5c8afaaa11d003334ea5e","59d2a7d671eb380010282dfa","59d2a804610da1003c9e101f","5a8de4e4a0a8e800129e878f","5accc3565093160003ea6144","5b0c4651b7985e0003070a11","5b16b16752e2960003e3132c","5b96b2ae40d30c0003f22483","5b96b33feea09300037d7124","5b9829adf807610003ff9645","5bdc662159aea40023bbe834","5c803fafed2d7e002d0c13b5","5dd83bf6750b24039c954fe4","5ddc023a8035950056c5ffb2","5de56b3cf93f2802705ed6f8","5de56f5ad0f89d003c089ef7","5de56fbb9b1b0e0316ea4896","5de57b7562ca2502a2cb37f6","5de5898ace84aa002bad88de","5de589f1f15cfa0380010a09","5de58a1290252f02d800bd23","5de68435202414007399b6c3","5de7f2cc522a8b002f395cfb","5de7f314a0cdc801b4a290bd","5de80341162de4001313d266","5de803fb0427ff005e827a47","5de8044d162de4001313d289","5de90e971817ee0072b1c09a","5defe166b711d800208f831b","5defe44353ee080024b068fa","5e21f2d6f1748c0048dcace1","5e29c9a6ee2a9600517f71ee","6046387e554ace002619dee6","604638d7c8e4cb0034c68ce8","604ba8bbf898e700183563c2","615eefb8bd8a7f01b1aaff52","61c1d85374ec00003eca058d","621e7558bf042d002e88c84b","635aba73a6345a00461e0a68","6376b43c081e400003bad2c6"],"codename":"","createdAt":"2015-06-02T22:22:25.207Z","is_stable":false,"project":"556e2ca0c9d85a1900914d28","releaseDate":"2015-06-02T22:22:25.207Z","version_clean":"1.0.0","is_deprecated":false},{"_id":"600ef58ee2a122003d3c0559","version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["556e2ca1c9d85a1900914d2c","57c882d89e6bca0e007edecb","600ef58ee2a122003d3c04bd","57d58dce17b492170053a3fc","57d59a0465a96a170037d0e9","57d59a35b0249a0e002bba04","57d5a0a3e2e70e20009cda30","600ef58ee2a122003d3c04be","600ef58ee2a122003d3c04bf","600ef58ee2a122003d3c04c0","58d14a1cfca38f1b00f7a177","590211faa244811900a7ac33","600ef58ee2a122003d3c04c1","600ef58ee2a122003d3c04c2","600ef58ee2a122003d3c04c3","600ef58ee2a122003d3c04c4","600ef58ee2a122003d3c04c5","600ef58ee2a122003d3c04c6","5963875ea3b85d001b60e9ba","600ef58ee2a122003d3c04c7","59d2a7d671eb380010282dfa","59d2a804610da1003c9e101f","600ef58ee2a122003d3c04c8","5accc3565093160003ea6144","600ef58ee2a122003d3c04c9","600ef58ee2a122003d3c04ca","5b96b2ae40d30c0003f22483","600ef58ee2a122003d3c04cb","5b9829adf807610003ff9645","5bdc662159aea40023bbe834","5c803fafed2d7e002d0c13b5","5dd83bf6750b24039c954fe4","5ddc023a8035950056c5ffb2","5de56b3cf93f2802705ed6f8","5de56f5ad0f89d003c089ef7","5de56fbb9b1b0e0316ea4896","5de57b7562ca2502a2cb37f6","5de5898ace84aa002bad88de","5de589f1f15cfa0380010a09","5de58a1290252f02d800bd23","5de68435202414007399b6c3","5de7f2cc522a8b002f395cfb","5de7f314a0cdc801b4a290bd","5de80341162de4001313d266","5de803fb0427ff005e827a47","5de8044d162de4001313d289","5de90e971817ee0072b1c09a","5defe166b711d800208f831b","5defe44353ee080024b068fa","5e21f2d6f1748c0048dcace1","5e29c9a6ee2a9600517f71ee","605bf12d01db370016cb3bfd","6089968aa9c8bb031178ab08","60899bb80da3bf00162f61ed","608aeba3174832005fbae500","61280504415308001182b364","616d7496d993940010e714cc","61df6c48854879002316a70a","61df6fe49fc45102c5b6f335","61df7047771c4e001631dede","61df79098186e601ed11b96d","61df8228ebe3e600170aaca8","61e44408d45a39002a020084","61e48f9613b4d00016050de8","621e7f413b032a00302b5d30","62a794a08db2710079153dc0","62a795262cc5e3009968e357","62be01225b452d0043fb57e9","6320aa968f0edb0038f3d01c","6363dc28fdf3b700101a9006","6376b43c081e400003bad2c7","63caffe61fc0a40017369ff1","63cb00011109090010d32caa","63cb004a8d17f000317f2aba","63cb0098916166005f64e5cc","63cb00cfa13a7600918ab7d9","63cb00f78d17f000317f3420","63d3ec4cfb028e00a603f6aa","6410e175294936005f555608"],"__v":0,"createdAt":"2015-06-02T22:22:25.207Z","project":"556e2ca0c9d85a1900914d28","releaseDate":"2015-06-02T22:22:25.207Z","forked_from":"556e2ca1c9d85a1900914d2b"}],"variableDefaults":[{"source":"security","_id":"62fd5a29c9fc4f006fd7aad9","name":"basicAuth","type":"http","scheme":"basic","apiSetting":"60899bb80da3bf00162f61ec"},{"source":"security","_id":"671ba533f6d281005a2d7e7a","name":"bearerAuth","type":"http","scheme":"bearer","apiSetting":"6089968aa9c8bb031178ab07"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"2.0"},"description":"PartnerStack connects to key events in your business to automatically incentivize and reward partners like resellers, consultants, and ambassadors.\n\nBy fingerprinting traffic from your partners, PartnerStack's technology identifies and rewards the people and organizations growing your business.","glossary":[],"homepage_url":"https://partnerstack.com","id":"556e2ca0c9d85a1900914d28","name":"PartnerStack","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"partnerstack","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"basicAuth","scheme":"basic","source":"security","type":"http","id":"62fd5a29c9fc4f006fd7aad9"},{"name":"bearerAuth","scheme":"bearer","source":"security","type":"http","id":"671ba533f6d281005a2d7e7a"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"mdx":"disabled"},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":true,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"refactored":{"status":"disabled","migrated":"unknown"},"reference":{"api_sdk_snippets":"disabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"business2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2024-05-29T18:36:52.363Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":"rnd8okf"},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"enabled","custom_code":{"css":"enabled","html":"enabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#434de1","link_color":"#434de1","theme":"light"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":"What's next...","footer":{"readme_logo":"hide"},"logo":{"size":"default","dark_mode":{"uri":null,"url":"https://files.readme.io/a624125-small-PartnerStack-logo-pack-2022_Logo_Horizontal_White.png","name":"PartnerStack-logo-pack-2022_Logo (Horizontal White).png","width":234,"height":80,"color":"#ffffff","links":{"original_url":"https://files.readme.io/c743406-PartnerStack-logo-pack-2022_Logo_Horizontal_White.png"}},"main":{"uri":null,"url":"https://files.readme.io/ca13b47-small-PartnerStack-logo-pack-2022_Primary_Logo_Horizontal_Full-color.png","name":"PartnerStack-logo-pack-2022_Primary Logo (Horizontal Full-color).png","width":234,"height":80,"color":"#262d94","links":{"original_url":"https://files.readme.io/79162e3-PartnerStack-logo-pack-2022_Primary_Logo_Horizontal_Full-color.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/e7ba444-small-PartnerStack-logo-pack-2022_Icon-only_Full-color.png","name":"PartnerStack-logo-pack-2022_Icon-only (Full-color).png","width":30,"height":32,"color":"#4b55cb","links":{"original_url":"https://files.readme.io/76ce44f-PartnerStack-logo-pack-2022_Icon-only_Full-color.png"}}},"custom_code":{"css":"p {color: #555;}\n\n/* Added as fix for ReadMe UI expand toggle bug */\nli.subnav-expanded.subnav-soft-toggle > a.text-wrap {\n color: #fff !important;\n}\n\nli.subnav-expanded.hub-sidebar-page > a.text-wrap {\n color: #fff !important;\n}\n\n/* Inline-code on response schema */\ndiv.response-schema code.rdmd-code {\n background: rgb(255 255 255 / 10%) !important;\n color: #fff !important;\n}","js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"line","gradient_color":"#b8cedc","overlay":{"fill":"cover","type":"triangles","position":"top-left","image":{"uri":null,"url":"https://files.readme.io/fc355d8-Green_Banner.png","name":"Green Banner.png","width":3640,"height":1000,"color":"#4bb373","links":{"original_url":null}}}},"navigation":{"first_page":"landing_page","left":[{"type":"guides","title":null,"url":null,"custom_page":null},{"type":"reference","title":null,"url":null,"custom_page":null}],"logo_link":"landing_page","right":[{"type":"link_url","title":"Support","url":"https://support.partnerstack.com/hc/en-us","custom_page":null},{"type":"link_url","title":"PartnerStack Login","url":"https://dash.partnerstack.com","custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"enabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":"Guides","visibility":"enabled"},"reference":{"label":"API Reference","alias":"API Reference","visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":"Releases","visibility":"disabled"},"discussions":{"label":"Discussions","alias":"Community Discussion","visibility":"disabled"}}}},"git":{"connection":{"repository":{},"status":"inactive"}}}},"version":{"_id":"600ef58ee2a122003d3c0559","version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["556e2ca1c9d85a1900914d2c","57c882d89e6bca0e007edecb","600ef58ee2a122003d3c04bd","57d58dce17b492170053a3fc","57d59a0465a96a170037d0e9","57d59a35b0249a0e002bba04","57d5a0a3e2e70e20009cda30","600ef58ee2a122003d3c04be","600ef58ee2a122003d3c04bf","600ef58ee2a122003d3c04c0","58d14a1cfca38f1b00f7a177","590211faa244811900a7ac33","600ef58ee2a122003d3c04c1","600ef58ee2a122003d3c04c2","600ef58ee2a122003d3c04c3","600ef58ee2a122003d3c04c4","600ef58ee2a122003d3c04c5","600ef58ee2a122003d3c04c6","5963875ea3b85d001b60e9ba","600ef58ee2a122003d3c04c7","59d2a7d671eb380010282dfa","59d2a804610da1003c9e101f","600ef58ee2a122003d3c04c8","5accc3565093160003ea6144","600ef58ee2a122003d3c04c9","600ef58ee2a122003d3c04ca","5b96b2ae40d30c0003f22483","600ef58ee2a122003d3c04cb","5b9829adf807610003ff9645","5bdc662159aea40023bbe834","5c803fafed2d7e002d0c13b5","5dd83bf6750b24039c954fe4","5ddc023a8035950056c5ffb2","5de56b3cf93f2802705ed6f8","5de56f5ad0f89d003c089ef7","5de56fbb9b1b0e0316ea4896","5de57b7562ca2502a2cb37f6","5de5898ace84aa002bad88de","5de589f1f15cfa0380010a09","5de58a1290252f02d800bd23","5de68435202414007399b6c3","5de7f2cc522a8b002f395cfb","5de7f314a0cdc801b4a290bd","5de80341162de4001313d266","5de803fb0427ff005e827a47","5de8044d162de4001313d289","5de90e971817ee0072b1c09a","5defe166b711d800208f831b","5defe44353ee080024b068fa","5e21f2d6f1748c0048dcace1","5e29c9a6ee2a9600517f71ee","605bf12d01db370016cb3bfd","6089968aa9c8bb031178ab08","60899bb80da3bf00162f61ed","608aeba3174832005fbae500","61280504415308001182b364","616d7496d993940010e714cc","61df6c48854879002316a70a","61df6fe49fc45102c5b6f335","61df7047771c4e001631dede","61df79098186e601ed11b96d","61df8228ebe3e600170aaca8","61e44408d45a39002a020084","61e48f9613b4d00016050de8","621e7f413b032a00302b5d30","62a794a08db2710079153dc0","62a795262cc5e3009968e357","62be01225b452d0043fb57e9","6320aa968f0edb0038f3d01c","6363dc28fdf3b700101a9006","6376b43c081e400003bad2c7","63caffe61fc0a40017369ff1","63cb00011109090010d32caa","63cb004a8d17f000317f2aba","63cb0098916166005f64e5cc","63cb00cfa13a7600918ab7d9","63cb00f78d17f000317f3420","63d3ec4cfb028e00a603f6aa","6410e175294936005f555608"],"__v":0,"createdAt":"2015-06-02T22:22:25.207Z","project":"556e2ca0c9d85a1900914d28","releaseDate":"2015-06-02T22:22:25.207Z","forked_from":"556e2ca1c9d85a1900914d2b"}},"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/docs/getting-started","version":{"_id":"600ef58ee2a122003d3c0559","version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["556e2ca1c9d85a1900914d2c","57c882d89e6bca0e007edecb","600ef58ee2a122003d3c04bd","57d58dce17b492170053a3fc","57d59a0465a96a170037d0e9","57d59a35b0249a0e002bba04","57d5a0a3e2e70e20009cda30","600ef58ee2a122003d3c04be","600ef58ee2a122003d3c04bf","600ef58ee2a122003d3c04c0","58d14a1cfca38f1b00f7a177","590211faa244811900a7ac33","600ef58ee2a122003d3c04c1","600ef58ee2a122003d3c04c2","600ef58ee2a122003d3c04c3","600ef58ee2a122003d3c04c4","600ef58ee2a122003d3c04c5","600ef58ee2a122003d3c04c6","5963875ea3b85d001b60e9ba","600ef58ee2a122003d3c04c7","59d2a7d671eb380010282dfa","59d2a804610da1003c9e101f","600ef58ee2a122003d3c04c8","5accc3565093160003ea6144","600ef58ee2a122003d3c04c9","600ef58ee2a122003d3c04ca","5b96b2ae40d30c0003f22483","600ef58ee2a122003d3c04cb","5b9829adf807610003ff9645","5bdc662159aea40023bbe834","5c803fafed2d7e002d0c13b5","5dd83bf6750b24039c954fe4","5ddc023a8035950056c5ffb2","5de56b3cf93f2802705ed6f8","5de56f5ad0f89d003c089ef7","5de56fbb9b1b0e0316ea4896","5de57b7562ca2502a2cb37f6","5de5898ace84aa002bad88de","5de589f1f15cfa0380010a09","5de58a1290252f02d800bd23","5de68435202414007399b6c3","5de7f2cc522a8b002f395cfb","5de7f314a0cdc801b4a290bd","5de80341162de4001313d266","5de803fb0427ff005e827a47","5de8044d162de4001313d289","5de90e971817ee0072b1c09a","5defe166b711d800208f831b","5defe44353ee080024b068fa","5e21f2d6f1748c0048dcace1","5e29c9a6ee2a9600517f71ee","605bf12d01db370016cb3bfd","6089968aa9c8bb031178ab08","60899bb80da3bf00162f61ed","608aeba3174832005fbae500","61280504415308001182b364","616d7496d993940010e714cc","61df6c48854879002316a70a","61df6fe49fc45102c5b6f335","61df7047771c4e001631dede","61df79098186e601ed11b96d","61df8228ebe3e600170aaca8","61e44408d45a39002a020084","61e48f9613b4d00016050de8","621e7f413b032a00302b5d30","62a794a08db2710079153dc0","62a795262cc5e3009968e357","62be01225b452d0043fb57e9","6320aa968f0edb0038f3d01c","6363dc28fdf3b700101a9006","6376b43c081e400003bad2c7","63caffe61fc0a40017369ff1","63cb00011109090010d32caa","63cb004a8d17f000317f2aba","63cb0098916166005f64e5cc","63cb00cfa13a7600918ab7d9","63cb00f78d17f000317f3420","63d3ec4cfb028e00a603f6aa","6410e175294936005f555608"],"__v":0,"createdAt":"2015-06-02T22:22:25.207Z","project":"556e2ca0c9d85a1900914d28","releaseDate":"2015-06-02T22:22:25.207Z","forked_from":"556e2ca1c9d85a1900914d2b"}}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>/*<![CDATA[*/window.zEmbed||function(e,t){var n,o,d,i,s,a=[],r=document.createElement("iframe");window.zEmbed=function(){a.push(arguments)},window.zE=window.zE||window.zEmbed,r.src="javascript:false",r.title="",r.role="presentation",(r.frameElement||r).style.cssText="display: none",d=document.getElementsByTagName("script"),d=d[d.length-1],d.parentNode.insertBefore(r,d),i=r.contentWindow,s=i.document;try{o=s}catch(e){n=document.domain,r.src='javascript:var d=document.open();d.domain="'+n+'";void(0);',o=s}o.open()._l=function(){var o=this.createElement("script");n&&(this.domain=n),o.id="js-iframe-async",o.src=e,this.t=+new Date,this.zendeskHost=t,this.zEQueue=a,this.body.appendChild(o)},o.write('<body onload="document._l();">'),o.close()}("https://assets.zendesk.com/embeddable_framework/main.js","growsumo.zendesk.com"); /*]]>*/ </script><script>!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","group","track","ready","alias","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+ "cdn.segment.com" +"/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="3.0.1"; analytics.load("WhMuLtc8oKwTqH9ehmMb0BQ72Sv2VJRJ"); }}(); </script><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6601,1126,6563,9772,4904,7449,7372,187,734,954,1167,2395,9321,3073,1008,7188,5753,2852,2249,3901,7783,1456,4935,4287,4201,1936,5798,2144,9141,1666,3906,3787,5948,8230,1313,1343,6060,9575,3221,7327,1202,1080,9852,8684,2447,3859,7717,5359,3307,3556,5408,2637,2402,7031,7356,2578,1731,4793,2616,3412,8063,678,8899,2705,6794,169,3626,7779,2548,5458,8778,5363,4467,6262,1813]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Doc","Footer","routes-Changelog","Post","routes-PageNotFound","routes-Landing","routes-Reference","core-icons-more-vertical-svg","core-icons-lock-svg","core-icons-arrow-right-svg","core-icons-search-svg","core-icons-custom-pages-svg","core-icons-alert-circle-svg","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","CustomPage","core-icons-chevron-down-svg","routes-SuperHub-Routes","core-icons-key-svg","routes-Discuss","Page","core-icons-message-circle-svg","RMDX","core-icons-eye-off-svg","List","core-icons-star-svg","core-icons-trending-up-svg","core-icons-callout-info-svg","core-icons-arrow-up-right-svg","core-icons-webhook-svg","New","core-icons-chevron-right-svg","core-icons-code-svg","core-icons-plus-svg","core-icons-book-svg","core-icons-gauge-circle-svg","core-icons-folder-plus-svg","core-icons-settings-svg","core-icons-oas-svg","core-icons-help-circle-svg","routes-Tutorials","SuperHub-CustomPage","routes-CustomPage","core-icons-unlock-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.f2baed1db5157d5aeba1.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1126.9d43ffa1039df16a8271.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6563.fbd3d15eee3b5e94f665.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.89a3e895d3051e33cd73.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4904.1067704c85da57778e22.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.fbd27ab77e6e47de9931.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/187.23cea47109f7f88417f6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1167.a6c63c62c8690225da20.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.771431a607874f268eb2.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9321.7bab74274e71e18bb347.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3073.ef6aff2d0ae6023765f1.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1008.2407cb357f385eb9ff9c.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7188.f444adf64944d115c52b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5753.72c5d7402efc1cfa5881.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.3432b44653552d31effc.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/2249.08687f22f6d6de29577d.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3901.9a23139e8c32bd6a1186.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.54e7cbd61e710313e1e0.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.415a3e3f42422a2546f5.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4201.9726bbf672400e046cc2.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.ab23d1cf8ea817ed6084.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.732d39065ba473dca3be.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.05be16260f5ffacc35a3.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.0ba0ba3778e78d8254e8.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.e4a4a4dbb41ce1f8c60f.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/3906.b84848dda7e7f59abf47.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.43a15229736801911d5a.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/8230.178147e4516bfa8b760d.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.a6b1c6bee69d46fd161f.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.fcff689c44b953a512d6.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/CustomPage.29543915f3e70fa960d7.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.48b876dfa499613f04d9.js"></script> <script async data-chunk="core-icons-key-svg" src="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.9a682a77c9083927aeaf.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/2637.d47bf77a75f266a70e80.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.6d18db72aa3774dd903a.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="RMDX" src="https://cdn.readme.io/public/hub/web/RMDX.6966846032c03969e44f.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.b1dd4485529aa4a7aa11.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.19db37c76f3b9d17353d.js"></script> <script async data-chunk="core-icons-chevron-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-right-svg.34d126524d8ea236d174.js"></script> <script async data-chunk="core-icons-code-svg" src="https://cdn.readme.io/public/hub/web/core-icons-code-svg.d29a4cf99a7105e13528.js"></script> <script async data-chunk="core-icons-plus-svg" src="https://cdn.readme.io/public/hub/web/core-icons-plus-svg.a49fb76ac2661b5e1c7e.js"></script> <script async data-chunk="core-icons-book-svg" src="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"></script> <script async data-chunk="core-icons-gauge-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-gauge-circle-svg.fff25782546fef314a09.js"></script> <script async data-chunk="core-icons-folder-plus-svg" src="https://cdn.readme.io/public/hub/web/core-icons-folder-plus-svg.2c200438e59611867262.js"></script> <script async data-chunk="core-icons-settings-svg" src="https://cdn.readme.io/public/hub/web/core-icons-settings-svg.bb875a1c38f51ce460bd.js"></script> <script async data-chunk="core-icons-oas-svg" src="https://cdn.readme.io/public/hub/web/core-icons-oas-svg.2dabf01f334b141bfe4b.js"></script> <script async data-chunk="core-icons-help-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-help-circle-svg.5b015602206396831950.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.c83f9bb228d60f5f7f6b.js"></script> <script async data-chunk="SuperHub-CustomPage" src="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.edef7b501475b233c5a2.js"></script> <script async data-chunk="core-icons-unlock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-unlock-svg.d27591cc9e0be731e26d.js"></script></div><script async="async" src="https://www.googletagmanager.com/gtag/js?id=G-9LGJT75MH4"></script><script>window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-9LGJT75MH4');</script><script>$(window).on('pageLoad', function(e, state){ analytics.page(window.location.pathname, state.meta.title, { "context": { "plugin": { "name": "readme_io", "version": "1.0.0" } } }) }); </script><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"Y2JiNGM3N2I1MDI1ZWQxZWI5ZjZkMjIzMjViOTU5YzU2MzU3OWU3NTgyYmQ0Y2E4ODI4ZDhjYzdlNzVhMTEyYXRhZ0ZpbHRlcnM9KHByb2plY3Q6NTU2ZTJjYTBjOWQ4NWExOTAwOTE0ZDI4KSwodmVyc2lvbjpub25lLHZlcnNpb246NjAwZWY1OGVlMmExMjIwMDNkM2MwNTU5KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","filters":"tagFilters=(project:556e2ca0c9d85a1900914d28),(version:none,version:600ef58ee2a122003d3c0559),(hidden:none,hidden:false),(index:CustomPage,index:Page)","metaData":[{"modules":{"examples":true,"landing":true,"reference":true,"suggested_edits":true,"discuss":false,"docs":true,"logs":false,"changelog":false,"custompages":false,"tutorials":false,"graphql":false},"id":"556e2ca0c9d85a1900914d28","name":"PartnerStack","subdomain":"partnerstack","subpath":"","nav_names":{"discuss":"Community Discussion","docs":"Guides","reference":"API Reference","changelog":"Releases","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>