Manage API keys
Manage API keys can be accessed by clicking at the bottom of the Group Settings screen.
The user must have the following privileges enabled to access API key settings
Can edit group
Can access API keys
API access is a paid & metered service. API calls are metered per account. The service can be added and purchased under Service Settings.
Multiple keys can be active for the same account at the same time. All keys share the same service and are metered together against the allowed number of calls.
Please see API reference for details about how to make API calls, and what API features are available.
To add a new API key, click the (+) symbol in the header. The new key will be added to the list immediately.
Click the pencil symbol to view and edit the details. The trashbin symbol will delete the key.
Each key has the following settings:
| API key name | A user-defined name |
| Privileges | Enables the key for accessing the various API functions. Each key can have any combination of privileges enabled. |
| Key expires | The key will automatically stop working at the given date. |
| Inherit to subgroups | If checked, the key will allow access to groups below the current group. If not checked, only data in the current group can be accessed |
| Callback URI | Some API functions will generate a call-back. If this feature is used, enter the desired URI here. |
| Key ID | This is the first part of the credentials needed to user the API call (=username) |
| Key | This is the second part of the credentials. (=password) |
The Key ID and Key are auto-generated and can't be changed.