API keys for workspaces

API keys let you connect external systems, reporting tools, or automation pipelines directly to your EnergyID workspace. This gives you a secure, automated way to exchange data with your own servers or software.

See our general API documentation for more information on how to use your API key in your backend integration.

Why use API keys?

These API keys are ideal for reliable, ongoing backend integrations within your organization. Because the key is linked to the workspace rather than to an individual person, it keeps working even after the person who created it leaves the organization.

Each key has its own access level, matching the workspace roles:

• Viewer: read-only access.
• Contributor: write access with contributor-level permissions.
• Editor: write access with editor-level permissions.

Note: For internal records, the remote app gets access to detailed record and meter data. For external records, access is limited to data available in the workspace.

Create an API key

New API keys are shown only once, at the moment you create them. Save the key value immediately in a secure secret manager.

• Open the workspace and go to Configuration.
• Open the API keys feature.
• Click Generate key.
• Enter a clear name (for example, the name of the external system or the integration).
• Choose the desired API access level (Viewer, Contributor, or Editor).
• Click Create and copy the key immediately.

Rotate or delete a key

Rotate keys whenever a key may have been exposed, when team members leave the organization, or as a regular part of your periodic security maintenance. Simply create a new key for the same integration, and only delete the old key after you have updated your remote process.

Security recommendations

• Store keys in a secret manager, never in source code.
• Use separate keys per environment and per integration.
• Choose the lowest access level your integration needs.
• Rotate keys periodically and after incidents.
• Log key usage in your own backend where possible.

FAQ

What happens to the API key when the creator leaves the organization?

The key keeps working as normal. Because these API keys are linked to the workspace and not to an individual user, your integrations and backend systems keep running without interruption.

Can I use the same API key for multiple workspaces?

No, an API key is created per workspace. This ensures a secure separation of access rights per project or organizational unit.

What is the difference with a personal API key?

These API keys are meant for automated background processes and server integrations at the workspace level. Personal API keys are linked to an individual user account and only grant access to your own personal records, separate from the workspace's records.

Why can I no longer see the full key value in the list?

For security reasons, EnergyID shows the secret key value only once, at creation time. After that, the key is no longer displayed for security reasons.

What is the difference between internal and external workspace records for API access?

Internal records offer broader access, through both the general workspace endpoints and specific record endpoints. External records are more limited and can only be accessed through the workspace endpoints.