API keys

Keys for connecting the product to whatever else your firm runs — each one scoped to exactly what it may do, and shown to you once, in full, at the moment you create it.

When you would use this: building your own integration, or connecting a tool that talks to the product over its API.

Creating one: a name so you remember what it is for, and the scopes it should carry — offered only from the scopes you yourself currently hold, so a key can never do more than the person who made it could do by hand. An optional expiry date retires it automatically.

Seeing it again: you cannot. The full key is shown exactly once, at creation; afterwards the screen shows only its prefix and last four characters, enough to recognise it in a list, never enough to use it.

Revoking one: immediate and permanent — a revoked key stops working the moment you revoke it, and nothing brings the same key back; make a new one instead.

Using a key: the same key works two ways — against the product's own REST API, documented in full at /docs/api, and, for connecting an AI assistant such as Claude Desktop, as an MCP server at the same address. Either way it can only do what its own scopes allow; see the API documentation page for how to connect either one and what each scope covers, rather than repeating it here.

A narrower view: none by itself, but a key's own reach is narrowed by whatever scopes you held the day you made it — losing a capability later does not retroactively shrink a key already issued with it.

When it refuses: no API keys item in your menu means either you lack the API permission (by default Admin and above) or your firm's plan does not include the API module — ask an Owner or Admin, or see Your plan.