Skip to main content
API keys requires the Enterprise plan; on a lower plan the page shows an upgrade prompt instead. An owner can create and revoke any key. A member whose role has the Manage API keys permission can create and revoke keys too, only in the workspaces where their role has it, and never with more access than their own role. No built-in role has that permission and built-in roles can’t be edited, so it needs a custom role with the permission turned on, cloned or created on Roles & Permissions. Keys that act for members stay with owners.
The API keys settings page listing keys by name, prefix, access, issuer and statusThe API keys settings page listing keys by name, prefix, access, issuer and status

API keys, listing each key's name, key prefix, access, who issued it and its status.

Manage the organisation’s API keys here: create a new key, and revoke ones you no longer use. Four cards summarise them (Total keys, Active, Expiring soon and Revoked), and the table lists each key’s Name (with when it was last used), Key prefix, Access, Workspaces, Issued by and Status. Access shows the key’s role, or Members for a key that acts for members (Members, up to a role when its access is limited). Workspaces lists the workspaces the key covers, default first; any you don’t belong to are counted rather than named. An organisation can hold up to 50 unrevoked keys at a time, and expired keys count until they are revoked; revoke one to make room for another. See the API reference for how to authenticate requests with a key.

Creating a key

Create API key asks for:
  • Name, for example Production server.
  • Act for members, off by default and shown to owners only. See Keys that act for members.
  • Role, the role the key acts as. The key acts as this role, not as you, and only roles with API access are listed.
  • Workspaces, one or more. The first is the default when a call names no workspace. A key that acts for members has no default, so each of its calls names one.
  • Expiry, optional. Leave it blank for a key that never expires.
Click Create key. The key is shown once, in Save your API key. Copy it straight away: it can’t be retrieved or rotated later, so if you lose it, revoke the key and create a new one. Nothing else on a key can be changed after it is created either.
The create API key dialog with Name, Act for members, Role, Workspaces and Expiry fieldsThe create API key dialog with Name, Act for members, Role, Workspaces and Expiry fields

Creating an API key.

Keys that act for members

Turn on Act for members for a system your team already uses, such as an HR platform. Packages it sends come from the person who triggered them, not from the key: emails go out in their name, replies and notifications reach them, and the package sits in their list. Each call names the member and the workspace, and gets that member’s own permissions there. It never gets to manage members or API keys. Template sharing applies too: the call sees only the templates that member can see. Edit locks work the same way: the call is held up by what another member is editing, not by what the named member has open. The member can be named by email, or by an API identifier your other system knows them by. See Authentication for how a call names a member. With the switch on, Limit access to replaces Role:
  • Each member’s own access sets no ceiling, so a call that names an owner gets every permission except managing members and API keys. It still can’t do what only an owner can.
  • A role caps every call at that role, whoever it names.
Choose a role under Limit access to, so the key has a ceiling whoever it names.

Revoking a key

Revoke key stops a key working straight away. This cannot be undone.