Skip to content

API keys and scopes

Create a key that can do exactly what one integration needs, and retire it safely.

Updated 23 September 2026

On this page
Why
Every call to the API or the MCP server has to prove which workspace it belongs to and what it may touch.
What
An API key begins kbd_, belongs to one organisation and carries a set of scopes.
How
Create it on the Kabaido API entry in Settings and send it as a Bearer token.

Create a key

  1. Step 1.

    Open /app/settings/integrations and open Kabaido API. Keys need the admin role or above; every plan has them.

  2. Step 2.

    Choose New key, name it after the integration that will use it and tick its Scopes.

  3. Step 3.

    Choose Create key and copy it. This is the only time the full key is shown.

Send it

bash
curl "https://kabaido.ai/api/v1/products?search=blade&limit=50" \
  -H "Authorization: Bearer kbd_your_key_here"

A missing, unknown or revoked key gets 401. A key without the scope a route needs gets 403.

Scopes

ScopeAllowsAlso needs
products:readList and search products
products:writeBulk upsert products by SKU
quotes:readList quotes and read one with its lines
quotes:writeReserved: no route or tool uses it yet
orders:readList orders and read one with its lines
customers:readList customers and read one with its contacts
customers:writeUpsert customers
requests:readList requests and read one with its messages
requests:writeOpen a request from enquiry text
stock:readRead stock lines, locations and the movement ledgerStock
stock:writeRecord a stock movement through the ledgerStock
deliveries:readRead deliveries with their lines and packagesRoute
suppliers:readRead suppliers and their contactsSource
purchase_orders:readRead purchase orders with their lines and receiptsSource

Keeping keys safe

  • Kabaido stores only a hash of each key, so a lost key cannot be recovered: create a new one.
  • The list shows each key's first characters and when it was last used. Revoking takes effect at once.
  • Make one key per integration, scoped to what it does: a nightly catalogue push needs products:write and nothing else.

Rotating a key

There is no rotate button. Create the new key, deploy it, watch last used move to it, then revoke the old one.