GET /api/v202510/energymanager/scope

Retrieves what the authenticated user's Watts answers are drawn from

GetDataScopeV202510
Use this endpoint to show the scope and currency of the data above a conversation: how many buildings, meters and accounts the user can see, the currency costs are reported in, and the most recent billing period that actually has bills in it. The counts are scoped by the signed-in user’s topmost places and cost centers, so they describe the data that user’s answers can be drawn from rather than the database as a whole. Requires the VirtualEnergyManager feature flag.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

WattsDataScopeV202510
Property Description Type
accounts Accounts the user can see. integer (int32)
buildings Buildings the user can see, already filtered to building places. integer (int32)
currencyCode Currency every cost figure is reported in. string
latestBillDate Latest service-period end date on any bill. string (date-time)
latestBillingPeriod Most recent billing period with a bill in it, as YYYYMM. This is where the data ends, which is not necessarily near today. string
meters Meters the user can see. integer (int32)
ownerName The organization whose data the user is signed in to. string
Example Response application/json
{  "accounts": 1,  "buildings": 1,  "currencyCode": "string",  "latestBillDate": "2026-10-09",  "latestBillingPeriod": "string",  "meters": 1,  "ownerName": "string"
}