Skip to main content
Version: 1.0

Mitzu API

Mitzu API​

The Mitzu API lets you manage a workspace's event tables, trigger indexing, update the event catalog and read event usage statistics, so Mitzu stays in sync when the tables in your data warehouse change.

It also manages who is in the organization and who can open each workspace: inviting, updating and removing members, deciding join requests, and opening or restricting workspaces. The API key acts as an Org Admin for these requests, but it is never the Org Owner and can't change ownership. Only keys an admin has allowed to manage members can make them; any other key gets 403.

Every error response has a JSON body with a single message field describing the problem.

Authentication​

API Key​

Admins can create API keys on the API keys tab of the organization settings. API access has to be enabled for your organization first; contact support@mitzu.io to turn it on.

A key can read and change the table configuration of every workspace in the organization, so store it as a secret. Managing members and workspace access also needs a key that an admin allowed to manage members, when creating it or later with Allow / Revoke member management.

Security Scheme Type:

apiKey

Header parameter name:

x-mitzu-api-key