Create a personal API key (PAT)

Learn how to generate your first personal API key in Omnifox to connect integrations, scripts, or external tools to your workspace.

Jun 26, 2026

Watch this step in the video · Create an API key

A personal API key (PAT, Personal Access Token) is a credential that lets external apps (n8n, Zapier, your own scripts) access Omnifox on your behalf without sharing your username and password. Every key is issued for one specific workspace and can be limited to certain permissions.

Before you start

  • Your plan must include API access (available on higher tiers). If it isn't active, you'll see a prompt to upgrade.
  • You need the Manage API keys permission (administrators have it by default).
  • You must belong to the workspace you're issuing the key for.

Steps

  1. In the side menu, open API Keys.
  2. Click New key.
  3. Enter a descriptive Name (for example, n8n integration - Sales). It helps you identify the key later.
  4. Choose the Workspace the key will operate on. This field is required: the key can only read and write data in that workspace.
  5. (Optional) Select the Scopes (permissions). If you leave them all unchecked, the key gets full access. Best practice is to grant only what you need.
  6. (Optional) Set a date under Expires at so the key retires itself.
  7. Click Save.

Verify it worked

When you save, a "Copy and save now" dialog shows the full key. It looks like 123_aBc... with a visible prefix such as omf_1a2b.

This is the only time the full key is shown. Copy it with the Copy button and store it in a password manager. After you dismiss the dialog, only the prefix remains.

Close the dialog and the new key appears in the API Keys list with its name, workspace, and prefix.

If it doesn't work

  • You see a plan notice (error 402): your plan doesn't include API access. Upgrade from Billing.
  • You can't find API Keys in the menu: you're missing the api-keys.view permission. Ask an administrator to grant it.
  • You can't pick a workspace: only workspaces you belong to are listed. Ask to be added to the right one.
  • You lost the key: it can't be recovered. Delete the old one and create a new key (or use Regenerate).

Tips

  • Use one key per integration: if one leaks, delete it without affecting the rest.
  • For automated integrations (not for you as a human agent), tick Service token (bot) when creating it.

Related articles

Was this helpful?

Related articles

Message us on WhatsApp