Generate & manage API keys
Edit in CMSAPI keys authenticate your requests to the Letterhead API. Two scopes are available: company-level keys (v3) for individual company operations and organization/brand-level keys (v2) for broader access. Only admins can generate and manage API keys.
Generate an API Key
Section titled “Generate an API Key”- In Settings, navigate to TODO: confirm exact Settings path for [Company / Organization] API Keys.
- Click Generate New Key or + Add Key.
- (Optional) Enter a descriptive name (e.g., “Zapier integration”, “AI tools”).
- Select the scope: v2 for organization/brand-level or v3 for company-level.
- Click Create or Generate.
- Your key will be displayed once—copy it immediately and store it securely.
Copy an API Key
Section titled “Copy an API Key”- Go to Settings > TODO: confirm exact path.
- Find the key you need in the list.
- Click the Copy icon or button next to the key.
- The key is now in your clipboard; paste it where needed.
Revoke an API Key
Section titled “Revoke an API Key”- Go to Settings > TODO: confirm exact path.
- Find the key in the list.
- Click Revoke or the delete icon.
- Confirm the action.
- The key is immediately disabled and cannot be used.
Key Security Best Practices
Section titled “Key Security Best Practices”- Treat API keys as secret—never commit them to version control or share them.
- Rotate regularly—revoke old keys and generate new ones periodically.
- Use different keys for different integrations—makes it easier to revoke one without breaking others.
- Monitor usage—check your key list periodically and revoke any you no longer use.
Next Steps
Section titled “Next Steps”Still can’t find what you need? Contact support.