Getting Started

The first thing you need before you can query the API is an API key. In order to generate a new API key, login to the web application, go to user settings -> API Keys. Don't see the API Keys menu in the settings page? This may be because the API integrations functionality is not enabled on your account, contact Customer Success for assistance in activating this functionality on your account.

API Key management

Once you have generated a new API key store it safely, we do not store your API in our systems and will not be able to recover it for you if it is lost!

You can create multiple API keys on your account, all active API keys that have been generated previously will be displayed in the same API Keys page in the app.

You can delete previously generated API keys to disable them, once a key is deleted it, clients will no longer be able make API calls with it and will receive Unauthorized errors when trying to query data with it.

Query the API

Once you have an API key, you are ready to start making queries. See the API Reference for the OpenAPI (swagger) documentation which lists the available endpoints and the data they provide.

Next steps

See the Key Concepts page to familiarize yourself with the key concepts of the API and how it functions, and check out the Guides for code examples.