Skip to main content
All CollectionsIntegrations
API User Roles and Rights Management
API User Roles and Rights Management

Gain granular control over API user access by assigning specific roles and permissions

Michael Batalha avatar
Written by Michael Batalha
Updated over 4 months ago

Previously, managing API access for your account involved a single API user and key. This limited your control over who could access your API and what actions they could perform.

With our enhanced API User Management feature, you now have the power to:

  • Create multiple API users with unique credentials.

  • Assign specific roles to each API user, granting them tailored permissions.

  • Control the level of access each user has to your API resources.

  • Disable, edit or delete API users as needed for security or administrative purposes.

This increased granularity in API user management provides better security and control over your account, ensuring that only authorized users can access the data and functionality they need.

How to Add an API User

Access the developer area and the very top you will see the "API ACCESS LIST" area. In order to create an API user, simply click the ADD API ACCESS button.

You will be presented with the following dialogue

The API ID

You can think of the The API ID as the "user". This is an identifier for your own internal use, to help you differentiate between the keys that you create, and who or what they're intended for. The field value can be an email address or consist of lowercase letters, numbers, and underscores.

User Rights

If you click into the API Rights field, you will get a list of all API methods, as well as a search field to help you easily find what you need. You can then proceed to tick the API methods that you want to allow access right to. If you want to allow full rights, simply tick the box left of the search field.

API IP Restrictions

If you want to limit access to this API key (user) only to certain specific IP addresses, you may do so in this field.

API Key

Note the auto-generated API key. We generate a random unique key each time you create a new user. This is essentially the user's credentials.

Notes

While the notes field is optional, we highly recommend making use of it, especially if you implement many different users and sets of permissions.

How to Edit, Disable or Delete an API User

Once a user is created note the actions area. It allows you to enable or disable a user by flipping the enable switch. In addition you may completely delete the user, or edit it to change any of the user's settings.

*Note that if a key doesn't allow any actions, this is a primary or master key for which you can only change access by IP addresses and no other actions can be performed on it. Only an administrator can delete it or disable access to it.

Did this answer your question?