Skip to main content
All CollectionsIntegrations
Developer Documentation
Developer Documentation

Learn about & access QuotaPath's API

Updated over a year ago

API Overview:

  • Our APIs allow external software platforms to send data in or out of your QuotaPath workspace. We currently have two available APIs:

    • Inbound Deals: Allows customers that don't use one of our native integrations (Salesforce, HubSpot, Close.com) the ability to send deal data into QuotaPath

    • Outbound Payouts: Allows for querying Resolved Payouts to send to external software systems, outside of our native integration with SaaSOptics

  • Our APIs are Open APIs, also known as public APIs, and are available for external (you!) use. However, in order to obtain an API key, you must be on a paid subscription plan.

  • To use the API requires resources from your development team. We have open API documentation that makes information quickly accessible and understandable for your developers

Implementation:

  • Quick step-by-step overview

    • Step 1: Select an API - Choose between our Inbound Deal (most common) or Outbound Payouts API

    • Step 2: Generate an API token - This is a unique code that identifies yourself as a valid customer and authenticates requests. View this article to learn how to generate an API token.

    • Step 3: Review the API documentation - This is your instruction manual on how to use and integrate with the API

    • Step 4: Write a request to an endpoint - This step will be handled by your developers. Once the API connection is made, QuotaPath will create new deals when they are sent.

  • QuotaPath Responsibility:

    • We help build your team's compensation plans in your QuotaPath workspace BEFORE the API implementation begins (Plan IDs and Path IDs needed for customer to write API calls)

  • Customer Responsibility:

    • Write API calls leveraging QuotaPath’s API documentation

    • For integrating a CRM through our API, you will need to set up your own data filtering and path mapping and send us the exact set of deals for that path in that plan. For instance, your software may to send "New Business" deals to the "New Business" path in your compensation plan.

  • We know APIs can feel overwhelming and full of technical jargon. That’s why our Customer Success team will be there to support you through the implementation process. We can help guide you on how you should be filtering data for plans & paths when using the Inbound Deal API, and answer any questions that come up along the way.

Inbound Deal API:

  • What can it do?

    • Get Deals

    • Create Deals

    • Bulk Create Deals

    • Update Deals

    • Remove Deals

    • Get QuotaPath Path Info

    • Get QuotaPath User Info

  • What can’t it do?

    • Create Plans/Paths

    • Create Payouts/Clawbacks

    • Create Ledger Entries

    • Approve Deals

Outbound Payouts API:

  • What can it do?

    • List all Payouts (Unresolved & Resolved)

    • List all Unresolved Payouts

    • List all Resolved Payouts

  • What can’t it do?

    • Create Payouts/Clawbacks

    • Resolve Payouts

Frequently Asked Questions

  • Who should use the API?

    • If the software you use as your source of truth for storing deal information is not yet offered as a native integration, Inbound Deals API is a great way to connect your data.

    • If you’re currently using Bulk Upload for deals, using the Inbound Deals API to integrate is a viable solution and will save your team time in the long run.

  • What types of CRMs or Applications do the API work with? Are there any restrictions?

    • The short answer is no. If you can build to our API and pass the required data, we can create deals. Almost all CRMs will work using the API. An example of a CRM that might not work would be a homegrown CRM.

  • Is this worth the time investment and development resources?

    • QuotaPath provides a rich experience for managing compensation with many “plug and play” native integrations, however, our API makes it accessible for your team to integrate with the tools you use to make QuotaPath work for you. While there is an upfront investment of resources, the long term gains are time savings, consolidation of platforms, better experience for your team, streamlined workflows, and more.

  • How much developer time will it take on the customer’s side to use the API?

    • We wish we could waive our wand and tell you, but unfortunately, we aren’t equipped to answer that. It depends on the complexity of systems to send to QuotaPath via the API, and the resources of of your developers.

  • Does QuotaPath charge for API calls?

    • No, QuotaPath does not charge for API calls. How often you want to send QuotaPath data / make API calls is totally up to you.

  • Is there a way to integrate to QuotaPath without using the API?

    • Yes. If you use HubSpot Sales CRM, Salesforce, or Close.com as your CRM, we have native integrations. We also integrate directly with Financial Operations Platform, SaaSOptics.

Did this answer your question?