Managing API Keys

Overview

API keys allow external applications and integrations to authenticate with your ContactDrive workspace via the REST API. Workspace admins can create, view, regenerate, and delete API keys as needed.

Step-by-Step

Creating an API Key

1. Navigate to Settings in the sidebar (admin access required).
2. Click the API Keys tab.
3. Click Create API Key to generate a new key.
4. The new key will appear in the table. Copy it immediately, as it will be masked after you navigate away.

Viewing and Copying a Key

1. On the API Keys page, your keys are displayed in a table with the key value masked by default.
2. Click Show next to a key to reveal the full key value.
3. Click Copy to copy the key to your clipboard.

Adding a Description

1. Click the description field next to a key to add or edit a description (e.g., "Zapier Integration" or "Internal Reporting Tool").
2. Save the description to help you identify the purpose of each key.

Regenerating a Key

1. If a key has been compromised or you want to rotate it, click Regenerate next to the key.
2. Confirm the regeneration. The old key will immediately stop working, and a new key will be issued.
3. Update any applications or integrations that use the old key with the new value.

Deleting a Key

1. Click Delete next to the key you want to remove.
2. Confirm the deletion. The key will immediately stop working, and any applications using it will lose access.