TalentOS Help
For developers

API keys (read access)

Create and manage read-access API keys so external tools can connect to your workspace.

Admins can create API keys that let external tools authenticate against your workspace and read its data — useful for integrations and reporting. Keys are scoped to your workspace, so a key only ever reaches your own data.

Manage keys under Admin → API Keys (/admin/api-keys). Only admins can view or manage this page.

Create a key

  1. Go to Admin → API Keys and select Create key.
  2. Give the key a name so you can recognize it later — for example, the tool or integration that will use it.
  3. Select Create key. The full key is generated and shown to you.

The full key is shown once, at creation. Copy it then and store it somewhere safe. We only keep a secured hash of the key and cannot recover or show it again — if you lose it, create a new one.

Each key begins with a short prefix (shown in the list) so you can tell your keys apart without ever seeing the full secret again.

Manage and revoke keys

The API Keys page lists each key with its name, prefix, creation date, when it was last used, and its status (Active or Revoked).

To turn off a key, select Revoke on its row and confirm. Any tool using that key immediately loses access. Revoking can't be undone — to restore access, create a new key. Revoked keys stay in the list for your records rather than being deleted.

Each workspace can hold up to 100 keys. Revoke keys you no longer use to free up room, or contact support if you need the limit raised.

Using a key

A key authenticates external, server-to-server tools against your workspace's API. Requests carry the key as a bearer token in the Authorization header. If a key is missing, malformed, unknown, or revoked, the request is rejected.

A fuller API reference — including the available endpoints and the exact data each one returns — is on the way. This page will be expanded with request examples once that reference is published.

On this page