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 Accesses" Section

From the main menu, locate and click on the "API Accesses" 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, email and permissions.

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.