Create an API key

Create a scoped API key to pull time, project, and analytics data out of WorkMonitor over the public API.

Who this is for

Creating, editing, and revoking API keys all need the permission that manages the organization, which only an owner holds by default; anyone else sees "Only an owner can manage API keys" in place of the key list.

Before you start

Decide which scopes the key needs and, if you want one, an expiry. You set both while creating it.

Steps

Open API keys and select New key (or Create your first key if none exist yet).
Enter a Name for the key.
Under Scopes, check every permission this key should be allowed to use (each one is listed by its own permission name, such as time:read or projects:manage); at least one is required.
Optionally set Expires in (days); leave it blank for a key that never expires.
Optionally add one or more ranges under IP allowlist (CIDR), one per line; leave it blank to allow any source IP.
Select Create key.
On Copy your API key, select Copy to copy the secret to your clipboard, then Done. This is the only time the secret is shown.

What happens next

The key appears in the Keys list with an active status, its scopes, and its Last used, Expires, and Source IPs summary. The raw secret itself is never shown again, only its prefix.

If it doesn't work

If you don't hold the permission to manage API keys, you'll see "Only an owner can manage API keys": "Ask an owner to create a key, or sign in as one."
If creating the key fails for another reason, you'll see "Couldn't create the key. Try again." or the server's own message.
To change what an existing key can do, select Edit on that key instead of creating a new one. Its secret doesn't change and isn't shown again.
If a key is compromised or no longer needed, select Revoke and confirm "Revoke this API key?". Doing so means it "stops working immediately and permanently. Any integration using it will start getting 401s. This can't be undone." There's no way to reissue the same key's secret from this screen; create a new key to replace it.

Integrations