Skip to main content
Open /settings/api-access to manage API keys for approved technical integrations. This Product Guide page explains the dashboard workflow only. Implementation details and code examples belong in the Developers section.

​
Access prerequisites

API Access is available only on supported paid plans. If your plan does not include it, the page shows an Upgrade required warning. Only authorized workspace users should create, rotate, or revoke API keys.

​
What the screen includes

  • Create new API key
  • Optional expiry date
  • Copy newly created key
  • View existing keys
  • Rotate key
  • Revoke key
  • View usage and status information

​
Create an API key

To create a key:
  1. Enter a clear key name.
  2. Set an expiry date if your organization requires one.
  3. Click Create API Key.
  4. Copy the new key when it appears.
  5. Store it in your approved secure location.
The newly created key is shown immediately so you can copy it. Treat it as sensitive information and share it only with the technical owner who needs it.

​
Suggested naming pattern

Use names that identify purpose and environment without exposing sensitive values:
  • prod-main-app
  • staging-api
  • crm-integration
Avoid using personal names or sensitive customer information in key names.

​
Existing key table

The key list can show:
  • Name
  • Prefix
  • Usage count
  • Last used date
  • Expiry date
  • Status
  • Actions
The prefix helps you identify a key later without exposing the full key.

​
Rotate a key

Use Rotate when a key should be replaced. Recommended handoff:
  1. Tell the technical owner before rotating.
  2. Rotate the key.
  3. Copy and deliver the new key through your approved secure process.
  4. Ask the technical owner to confirm the update is complete.
Do not rotate production keys without coordinating with the person or team using them.

​
Revoke a key

Use Revoke when a key should no longer be usable. Before revoking:
  • Confirm the key is no longer needed
  • Confirm any replacement key is already in use
  • Check with the technical owner if you are unsure
Revocation cannot be undone for that key.

​
User checklist

  • Create keys only when there is a clear business need.
  • Use purpose-based names.
  • Copy and store new keys immediately.
  • Share keys only through approved secure channels.
  • Rotate keys with coordination.
  • Revoke unused or stale keys promptly.