Skip to main content
This section is for building on Karzoun. Day-to-day product guides are in the Help Center. If the API is down for every workspace, check Status.

​
Start here

Quickstart

Make one API call and see a real response.

Authentication

Create the API key that call uses.

GraphQL API

Look up a query, mutation, or type.

Webhooks

Receive an HTTP request when something in the workspace changes.

MCP

Let Cursor, Claude, or ChatGPT call the API for you.

MiniApps

Publish an app other workspaces can install.

​
Which one you want

Call GraphQL when your server needs data now. Use a webhook when you want Karzoun to tell you that something changed. Use MCP when an AI app should call the API. Use the Dashboard SDK when you are embedding a panel in the inbox. Use MiniApps when you are shipping a connector other people install.

​
A call

A successful response has a data object. A failed one has an errors array. See Errors.

​
Before you ship

  • Keep the API key on your server. Never put it in browser JavaScript or a public repo.
  • Check X-Karzoun-Signature-256 on every webhook before you trust the body. See Webhooks.
  • Give the key only the scopes that job needs, such as contacts:read.
  • Revoke the key in Developer → API keys when that person or integration goes away.
Last modified on August 12, 2026