How do I create an API key?

Worktivity exposes a separate read API for integrations. A key belongs to the organization, and any request carrying it can read everything that organization holds.

Creating a key

1. Open the workspace name at the top of the sidebar and choose Workspace settings.
2. Open the API access tab.
3. Press New API key, give it a name of up to thirty characters, then press Create key.
4. Copy the key into your integration.

The name is only for you. Give it the name of the integration that will use it, so a key can be retired later without guessing.

Seeing a key again

The list shows dots, not the key. Press Reveal on the row to fetch the readable value; it hides itself again after about forty-five seconds. There is no one-time-only rule here, a key can be revealed as often as you need.

How the key is sent

As a query parameter named x_api_key, not as an authorization header:

https://open-api.useworktivity.com/Employee/List?x_api_key=YOUR_API_KEY

Requests are limited per key to five per second, one hundred per minute and one hundred thousand per hour. Anything above that comes back as 429.

Turning a key off against deleting it

• Deactivate: the status switch on the row. Requests carrying that key are rejected from the next call onwards, and turning it back on restores them. Use this to pause an integration.
• Delete: permanent. Everything built on that key starts failing and the key cannot be restored.

A key reads employees, teams, timesheets, screenshots, projects, leave records and insights for the whole organization. Keep it on a server, never in a browser, a mobile app or a public repository.

Plan and limits

Creating a new key needs a plan that includes API access. If your plan does not, the tab still lists the keys you already have, and they still work, so an exposed key can always be deactivated or deleted. Changing your plan covers the upgrade.

An organization can hold up to ten keys, and the tab counts them for you. Worktivity does not record when a key was last used, which is why the table has no such column.

Endpoint documentation

The button in the card header opens the developer pages on the Worktivity website, where the endpoints, parameters and examples are listed. The rest of the settings screen is described in what is in Organization settings.