API Scope Definitions

Easee recommends the use of OAuth2 primarily for integrations that require read-only access to Easee charging consumption data, or where the integration needs to view or update the operator assigned to a site, as part of an onboarding flow.

The following OAuth scopes define the level of access that third-party applications can request when integrating with Easee services.

If you wish to control an Easee asset, please sign up to become an operator here.

Scope	Description	User Consent Text
`chargers:read`	View charger status, diagnostics, and telemetry data including operating mode, connectivity, power metrics, error states, temperatures, voltages, hardware versions, signal strength, and reboot history.	View your chargers' status and diagnostic data
`sites:read`	View site information including site details, regulations, circuits, fuse ratings, and installed devices.	View your sites and their configuration
`sites:operator:manage`	View and update the operator assigned to a site.	View and change site operator
`sessions:read`	Access charging session information, including active, recent, and historical sessions, consumption statistics, reporting data, and MID-certified metering records.	View charging session history and consumption reports
`account:profile:read`	Access user account profile information such as name, email address, phone number, account details, and company roles. This scope complements standard OIDC scopes (`profile`, `email`, and `phone`) which control token claims.	View your profile information
`equalizers:read`	View equalizer status and telemetry, including meter readings, current, voltage, power data, configuration, connectivity, child devices, and load-balancing status.	View equalizer status and configuration

Scope Selection Guidelines

When requesting permissions, applications should follow the principle of least privilege and request only the scopes required for their functionality.

Common Integration Scenarios

Use Case	Recommended Scopes
Charger monitoring and analytics	`chargers:read`, `sessions:read`
Operator management	`sites:read`, `sites:operator:manage`