Skip to main content

Create and manage API keys (Saturation 3.0)

API keys let scripts and integrations act in a Saturation workspace without using your browser session.

Each key belongs to the teammate who creates it. It follows that teammate's current permissions and does not have separate selectable scopes.

Create an API key

  1. Open Settings in the workspace.

  2. Select API keys.

  3. Select Create key.

  4. Enter a name that identifies the integration, such as Payroll import.

  5. Under Expires, choose Never, 90 days, 180 days, or 365 days.

  6. Select Create key.

  7. Select Copy, save the key in a password manager or secrets manager, then select I have saved my key.

Saturation shows the full key once. If you close the dialog before saving it, revoke the key and create a replacement.

Use the key

Send the key as a Bearer token:

Authorization: Bearer YOUR_API_KEY

Do not put a key in a shared document, source code, browser-side code, or a support message. Keep one key per integration so you can replace or revoke it without affecting other tools.

Review your keys

The API keys table shows the key name, owner, shortened key value, creation date, expiration, last use, and current status. The full key cannot be opened again.

Editors see and manage the keys they created. Workspace owners and admins can also see and manage keys created by other teammates in the workspace.

Accountants, commenters, and viewers cannot create API keys. If API keys is missing or locked, ask a workspace owner or admin to check your role and plan.

Revoke or restore a key

Revoke a key when an integration should stop immediately or when the key may have been exposed.

  1. Open Settings > API keys.

  2. Open the key's actions menu.

  3. Select Revoke and confirm.

Requests using the key stop working. Select Restore from the same menu if you need to reactivate the same key later and it has not expired.

Delete a key

A key must be revoked before it can be deleted.

  1. Revoke the key.

  2. Open its actions menu again.

  3. Select Delete and confirm.

Deletion is permanent. Create a new key if the integration needs access again.

How permission changes affect a key

A key uses its owner's live permissions on every request. Changing the owner's workspace role or project access changes what the key can do. Removing the owner from the workspace removes the access the key depended on.

There is no permission or scope selector when you create a key. To give an integration less access, create the key from a teammate account with the intended workspace and project permissions.

Did this answer your question?