apikeystokensscopesintegrationsecurity

Create and Manage CRM API Keys

Give an external tool only the access it needs.

Last updated

Create and Manage CRM API Keys

Personal API keys allow approved tools to access supported Red Bricks OS functions within your account.

Where to find it: Admin → Settings → CRM & API Keys

What to do

  1. Create a separate key for each app or purpose.
  2. Choose the minimum scopes required.
  3. Copy the key once and store it in that tool’s secure credential storage.
  4. Test the intended action.
  5. Revoke the key when the tool or person no longer needs access.

Good to know

  • A key is a secret. Never paste it into Help, email, notes, screenshots, or source code.
  • Key permissions cannot exceed the account and user access behind them.

Was this article helpful?