Scopes

Context

The Scopes API provides information about which API resources and endpoints are accessible with your API key. This is useful for understanding your current API permissions and discovering what data you can retrieve.

Available Endpoints

• GET /scopes - Retrieve available scopes and accessible endpoints for your API key

Data

The scopes endpoint returns an array of scope objects, each representing a resource you have access to.

Field	Type	Description
scope	string	Name of the resource (e.g. site-configuration)
paths	string[]	Array of API endpoint paths you can access

Available Scopes

Scope	Description	Included Endpoints
site-configuration	Access to site and charger configuration data	/rest/v1/sites
ocpp-logs	Access to OCPP protocol logs and diagnostics	/rest/v1/ocpp-logs
charging-sessions	Access to historical charging event data	/rest/v1/charging-events

Default Endpoints

The following endpoints are always included in your scopes:

• /rest/v1/ping - Liveness check endpoint
• /rest/v1/scopes - This endpoint

Example Response

{
  "scopes": [
    {
        "scope": "site-configuration",
        "paths": [
            "/rest/v1/sites/*"
        ]
    },
    {
        "scope": "default",
        "paths": [
            "/rest/v1/ping/*",
            "/rest/v1/scopes/*",
        ]
    }
  ]
}