Documentation
Users, roles, and API keys
Updated 17 Nov 2026
Roles are admin, operator, and viewer. Operator and viewer exist only on Team. API keys are a Team feature and are either read-only or read-write, and read-write is capped at operator. Disabling a user ends their sessions immediately.
Roles
The three role names are admin, operator, and viewer. An admin or an operator can write. A viewer is read-only: mutating requests are rejected except a short allowlist of read-style POSTs (report query and export, flow simulate, lander preview link). The admin UI describes it as admin for full access, operator for delivery configuration, viewer for read-only.
Pro does not enable the roles feature, so extra users on Pro are admins, up to the cap of 3. Team turns roles on and does not cap the user count. You cannot change your own role or status, so the last admin cannot lock themselves out. A password is at least 8 characters and at most 72 bytes. Changing your own password keeps the current session and invalidates the others.
Viewers, and MCP tokens without write on that domain, see a masked network key (•••• plus the last 4 characters). Webhook URLs and source postback templates are masked to the host. A viewer does not get the control that copies the postback link. Config export, which includes source postback templates, is operator and above.
API keys
API keys require Team (api_keys). Scopes are ["read"] or ["read","write"]. Omitting scopes creates a read-only key. A read key acts as a viewer. A read-write key acts as an operator at most. It cannot call users, API keys, backups, MCP tokens, the audit log, branding and general settings, license activate, software update, or demo data. Those stay admin routes and return 403. A key whose creator is not an active user stops working.
Disabling someone
DELETE /api/users/{id} or PATCH with status: "disabled" bumps the session generation. Existing logins fail on the next request. Their API keys stop. Their MCP tokens fail because the creator is no longer an active admin. Scheduled reports they owned stop because the scheduler joins active users. The rows are not necessarily deleted. Re-enabling the user does not restore old sessions; they sign in again.
Audit log is the Team feature that records who changed what. MCP tokens are covered on the MCP page, and the caps are on plans.