Skip to content
Kanroo
Sign inStart free

Create a personal API key

GuideUpdated

On this page

A personal API key lets a script, an integration, or an AI agent work in Kanroo on your behalf. A key can never do more than your account: if you lose access to a board, so does the key.

Your keys

The API keys of Dejan Vi.
  1. Open Personal settings from the account menu at the bottom of the sidebar, then the API keys tab.
  2. Create API key (box 1) adds a key.
  3. The list (box 2) shows each key with its scope, status, last use, and expiry.
  4. The row menu (box 3) has Rename and Revoke. A revoked key stops working at once.

Create a key

A read-only key for a reporting script

  1. Enter a Name (box 1) that says where the key is used.

  2. Pick the Scope preset (box 2):

    • Read: reads only.
    • Write: also creates, changes, and deletes.
    • Admin: also members, invitations, teams, access, and everything public.

    API-key scopes lists what each scope allows.

  3. Pick an Expiry (box 3). Shorter is safer.

  4. Choose Create key (box 4). Kanroo shows the key once. Copy it now and store it in a password manager or an environment variable.

Use the key

Send it in the X-API-Key header:

curl -H "X-API-Key: $KANROO_API_KEY" https://cloud.kanroo.app/api/v1/users/me/context

Only the MCP endpoint /mcp takes the key as Authorization: Bearer.

On a self-hosted Kanroo, use your own address. Your Kanroo serves the full API reference at /api/docs when the operator turns on API_DOCUMENTATION_ENABLED.

Good to know

  • Each key starts with kanroo_. Never commit a key to a repository.
  • API keys are personal settings: if you signed in with single sign-on (SSO), Kanroo asks you to verify your personal account first.
  • One key works in every organization you belong to, unless an organization turns personal API keys off in its SSO settings.
  • On Kanroo Cloud, the plan sets how many API requests an organization can make per minute. See Plans and limits.

Was this page helpful?