https://app.zarms.cloud/mcp) and the REST API (https://app.zarms.cloud/api/v1).
Who can do this: Owner, Manager (issue and revoke)
Issue a key
1
Open the API key screen
In the right-hand navigation, open Settings → MCP connections and click API key
connections (alternate method).
2
Set a name and permissions
Click Issue a new key and enter a Name that tells you what the key is for. Under
Permissions (scopes), choose Read only if you only need to read, or Read and write
if you’ll also create or update cards. You can also choose read and update access item by item.
3
Set the expiry and issue
Choose an expiry from No expiry, 30 days, 90 days, or 1 year, then click
Issue.
4
Save the key
Copy the key that appears (a string starting with
zarms_sk_) and keep it somewhere safe.Use a key
Add the key to your request headers like this:Revoke a key
Revoke keys you no longer use, or that may have leaked, on the API key screen. A revoked key stops working right away.How it differs from OAuth
Assigning which boards a member can open as a Guest (
members:write) is included in newly issued “Read and write” keys and newly approved “Read and write” OAuth connections. Keys and connections from before don’t include it, so issue a new key or reconnect if you need it.
Troubleshooting
- You see “Basic does not include API or MCP. Upgrade to Starter or higher.”: The API and MCP are available during the trial or on Starter or a higher plan (see Plans and trial).
- There’s no button to issue a key on the API key screen: Only Owners and Managers can issue keys.
- Calls with the key return an error: Check that the key hasn’t been revoked or expired, and that it has the permissions you need.