Before working with APIs you should confirm that you have a login to your QuickHelp Web Portal (https://quickhelp.com/routeurl) and that you have been granted “Administrator” privileges. Check with the your organizational QuickHelp Administrator or your BrainStorm Client Success Manager if these are not as described.


To access QuickHelp's APIs, you will need 2 API keys.  If this is the first time that you are generating an API, complete the instructions for generating a key below.


IMPORTANT:  If you have already generated an API key, generating a new API key will invalidate previously generated keys.  Make sure that a previously generated key is not being used before you generate a new one.



To access QuickHelp’s API, you will first need to generate an API key.


  1. Log in to the QuickHelp Admin Portal.
  2. Click Settings on the left-hand side.
  3. In the Configure tag, click Regenerate Key.
    4. Click SAVE CHANGES


NOTE: If this is the first time you have generated an API Key in the Admin Portal, it may take up to 48 hours for your QuickHelp data to be available an any API - this includes the SharePoint API Integration.


The second step is to obtain a subscription key, which we will generate for you. 


  1. Please send an email to: support@quickhelp.com
  2. This will create a ticket and our team will generate a subscription key for you.
  3. Please send the following information
    1. The name of an Admin
      1. First Name
      2. Last Name
      3. Email Address

  4. We will create the subscription key and send it back to you.

  5. NOTE: Your middleware must provide both the API key and subscription key in the header of each request. 

For more information on APIs, please reference the following documents:

QuickHelp APIs - the Basics

QuickHelp API Endpoints