How to Create and Manage API Keys

1. Viewing Existing API Keys

When you navigate to Settings → API Keys, you’ll see a list of all keys already created.

Here you’ll find:

• Key (masked) – the unique identifier for authentication.
• Name – the label you gave the key (e.g., “Default” or “CRM Integration”).
• Created – when the key was first generated.
• Last Modified – if changes have been made (e.g., permissions updated).
• Modified By – which team member created or last adjusted the key.

You can also see your API Credit Usage.

• Example: 87 / 5,000 means you’ve used 87 calls out of your monthly allowance of 5,000.
• This resets monthly for your company account.

2. Creating a New API Key

Click the + Add Key button to generate a new API key. You’ll be prompted to fill out:

• Name – Give the key a descriptive label (e.g., “Mobile App Integration”).
• Key Type – Usually Default, unless instructed otherwise.
• Description – Optional notes about what the key is used for.
• Expiration Date – Define when the key should automatically expire (recommended for security).

3. Setting Permissions

Each API key can have different modules and access levels:

Member Modules

These control what internal team members can do via the API. Examples include:

• Account – manage client accounts.
• Contact Report – create and update client interactions.
• Document – upload or retrieve files.

Client Portal Modules

These control what client-facing integrations can access. Examples include:

• Account – update account details from the client portal.
• Comment – allow clients to add or retrieve comments.
• Model Portfolio – access portfolio configurations.

Access Levels:

• Read Only – can view but not change data.
• Read/Write – can view and update data.

4. Using the API Key

Once created, your new key will appear in the list. You can:

• Copy the key using the copy button.
• View/hide the full key.
• Regenerate or delete if needed.

5. Monitoring Usage

Keep an eye on API Credit Usage to ensure you don’t exceed your monthly quota. If you consistently reach the limit, contact support to discuss upgrading your plan.