EmailGuard

Documentation

Creating API keys

How team admins create, scope, and rotate API keys for programmatic access.

Team owners and admins can create API keys from Team → Settings → API keys.

Before you create a key

  1. Decide which endpoints your integration needs — each route requires specific API key scopes.
  2. Prefer the minimum scopes required. You can always create a new key with broader access later. Public API routes are scoped to the team that owns the key.

Create the key

  1. Open Team → Settings → API keys.
  2. Choose Create key.
  3. Name the key for the integration (for example CI deploy or Billing sync).
  4. Select the scopes your app needs.
  5. Copy the secret immediately — it is shown only once.

Keys use the gsk_live_ prefix in production. Send them as Authorization: Bearer … or X-API-Key: … on every request.

Rotate or revoke

If a secret is exposed, revoke the key from Team settings and issue a replacement. Update your integration before deleting the old key to avoid downtime.

For scope details and team role permissions, see the Knowledge base.