Get started

All topicsDevelopers

Creating an API key

Creating a key, read and write scope, expiry, the IP restriction, and revoking.

In the panelProfile menu · Settings → API keysOpen this screen in the panel

What you do in the panel has an API counterpart. A key lets your own code, or an AI agent, use that API on behalf of your workspace.

  1. Step 1/4

    Create the key

    Press “Create key” on Settings → API keys. Name it after the integration that will use it — “claude-code”, “weekly-report”. In six months the name is what tells you which is which.

  2. Step 2/4

    Choose the scope

    Read or write. Read sees analytics, campaigns and creatives; write covers all of that plus changing status and budgets. Do not grant write unless it is genuinely needed.

  3. Step 3/4

    Set an expiry

    Never, or a number of days. An expiring key keeps a forgotten integration from staying open forever.

  4. Step 4/4

    Copy the key

    The full key is shown ONLY ONCE, at the moment it is created. If you lose it, it cannot be recovered — you revoke it and create another.

What the card shows

Status
Active, revoked or expired.
Created by
Who and when. No key is left without an owner.
Last used
When it was last used and from which IP. If never, it says so.
Expires
The end date on expiring keys.

IP restriction

You can define an allow list for the whole workspace: one IP address or CIDR block per line. While the list is populated, a request from an address that is not on it is refused. The screen also shows your current address and can add it in one click.

Revoking

Revoking a key immediately cuts off every integration using it. It cannot be undone; you create a new key and update the integration. Managing keys requires admin permission.