Skip to main content
API keys allow external tools and automations to interact with your LumiID workspace programmatically. You might use them to power a custom dashboard, sync content from an external tool, or integrate with a third-party service. Workspace admins can create, view, and revoke keys at any time from workspace settings.

​
Creating an API key

Go to Settings → API → Keys and click New API key. Give the key a descriptive name — for example, “Analytics integration” or “Content sync” — so you can identify it later.
Your key is only displayed once, immediately after creation. Copy it and store it somewhere secure right away. If you lose it, you’ll need to revoke the key and create a new one.

​
Key permissions

When creating a key, you can scope its permissions to limit what the integration can do:
Use the minimum permissions necessary for each integration. For example, a read-only reporting tool doesn’t need Write or Admin access.

​
Rotating a key

To rotate a key, create a new one first, update your integration to use the new key, then revoke the old one. There is no automated rotation — this is a manual process.

​
Revoking a key

Go to Settings → API → Keys, find the key you want to remove, and click Revoke. Revocation is immediate — any requests using that key will fail instantly.

​
Monitoring usage

Under Settings → API → Usage, you can see request counts per key over the past 30 days. Use this view to spot unexpected usage or to identify which integrations are most active.