How can I create an API key for my integration?

Integrating with our platform requires API access, which allows your systems to communicate securely with our services.

Users with the roles of Admin or Owner can create and manage API accesses from the API Accesses section of our control panel.

Step 1: Navigate to the "API Acccess" Section

From the main menu, locate and click on the "API Access" option. This section lists existing API accesses and allows you to create new ones.

Step 2: Click Add API Access

You’ll be prompted to configure the settings for this access: name, permissions and api version.

For read-only access: Choose Only Read option. This is ideal for integrations that only need to fetch data from our system. For broader functionality select Read and Write.

Our recommendation is that you create an API Access with fewer privileges required.

The API version determines which version of our API the key will be used with. If you are creating a new integration, we recommend using the latest available API version. If you are creating a new API Key for an existing integration, select the same API version currently used by that integration unless you are intentionally migrating to a newer version.