Skip to main content

Creating and Managing API Keys

API keys allow you to connect external tools or integrations securely to your account. There are three types of API keys, each with specific permissions and creation requirements.

Ishita Mishra avatar
Written by Ishita Mishra
Updated over 2 months ago

Overview:

Three key levels exist and each has different permission and creation requirements.

  1. User API Key
    - Inherits the permissions of the user who creates it.

    - Use when an integration needs to act as a specific user.
    ​

  2. Workspace API Key
    - Can only be created by users with the Workspace Editor role.

    - Grants access to a single workspace via the API.
    ​

  3. Organization (Orga) API Key
    - Can only be created by users with the Organization Owner role.
    - Grants access across the whole organization via the API.
    ​

⚙️ How to Create API Keys

1. User API Key

Use this when an integration should act as you (the user).

Steps:

  1. Click your profile icon at the bottom-left corner.

  2. Click on your name.

  3. Go to the API Keys section.

  4. Click Create API Key and enter a name.

  5. Copy the key immediately — it will not be visible again later.

2. Workspace API Key

Use this for workspace-level integrations.

Steps:

  1. Click your profile icon at the bottom-left corner.

  2. Click Settings.

  3. Select the Workspace you want to manage.

  4. Open the API section in the left panel.

    • If you see Workspace Settings instead of Settings, click that directly — it leads to the same place.

  5. Click Create API Key and enter a name.

  6. Copy the key immediately — it will not be visible again later.

🔒 Permission required: You must have the Workspace Editor role (or higher) to create a workspace API key.

3. Organization (Orga) API Key

Use this for organization-wide integrations.

Steps:

  1. Click your profile icon at the bottom-left corner.

  2. Click Settings.

  3. Go to the API section in the left panel.

  4. Click Create API Key and enter a name.

  5. Copy the key immediately — it will not be visible again later.

🔒 Permission required: You must be an Organization Owner to create an organization-level API key.

🧩 Best Practices

  • Treat API keys like passwords — never share them publicly.

  • Rotate keys regularly and revoke unused ones.

  • Store them securely using a secret manager or environment variable.

Did this answer your question?