API Keys

API keys enable secure programmatic access to your workspace for EHR integrations, CRM syncs, data pipelines, and custom automations.

Access the Settings

Navigate to Settings > API Keys in your workspace.

Create a Key

1. Click Create API Key.
2. Enter a descriptive name.
3. Choose scopes (permissions) based on your use case:
   • Read-only: members:read, chats:read, analytics:read
   • EHR/CRM sync: members:write, chats:write, records:write
4. (Optional) Set an expiration date.
5. Click create. Copy the full key immediately — it is shown only once.

Store Securely

• Use environment variables or a secrets manager (e.g., AWS Secrets Manager).
• Never commit keys to source control or share them in plain text.

Revoke or Delete

In the API Keys list, select and revoke any key that is expired, unused, or no longer required. This immediately invalidates the key.