Retrieves all energy projects associated with a place, with rollup for organizations
Use this endpoint to get energy projects for a place. For organizations, returns a rolled-up list
of energy projects from all child places in the hierarchy.
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. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| placeId | Unique numeric identifier of the place | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
Array of:
EnergyProjectResponse
| Property | Description | Type | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| costSavings | CostSavingsChild | |||||||||||||||||||||||||
|
CostSavingsChild properties
|
||||||||||||||||||||||||||
| energyProjectCode | Short alphanumeric code uniquely identifying this project (e.g., “LED-RETRO-2024”) | string | ||||||||||||||||||||||||
| energyProjectId | Unique numeric identifier of the energy project | integer (int32) | ||||||||||||||||||||||||
| energyProjectInfo | Descriptive name or title of the energy project | string | ||||||||||||||||||||||||
| energyProjectType | EnergyProjectType | |||||||||||||||||||||||||
|
EnergyProjectType properties
|
||||||||||||||||||||||||||
| energySavings | EnergySavingsChild | |||||||||||||||||||||||||
|
EnergySavingsChild properties
|
||||||||||||||||||||||||||
| expectedImpact | Expected energy impact classification: “positive” (saves energy), “negative” (increases energy), or “unknown” | string | ||||||||||||||||||||||||
| fundingSource | Description of the funding source for this project (e.g., “Capital Budget”, “Grant”) | string | ||||||||||||||||||||||||
| installationBeginDate | Date when project installation began. Format: date-only. Null if not set | string (date-time) | ||||||||||||||||||||||||
| installationCost | Total cost of the project installation in the organization’s base currency. Null if not set | number (double) | ||||||||||||||||||||||||
| installationEndDate | Date when project installation was completed. Format: date-only. Null if not set | string (date-time) | ||||||||||||||||||||||||
| note | Free-text note with additional project details | string | ||||||||||||||||||||||||
| place | EnergyProjectPlaceChild | |||||||||||||||||||||||||
|
EnergyProjectPlaceChild properties
|
||||||||||||||||||||||||||
| projectManager | Name of the person managing this project | string | ||||||||||||||||||||||||
| utilityRebate | Dollar amount of utility rebate received for this project. Null if no rebate | number (double) | ||||||||||||||||||||||||
Example Response
[
{ "costSavings": { "costSavings": 1.0, "costSavingsUnit": {}
}, "energyProjectCode": "string", "energyProjectId": 1, "energyProjectInfo": "string", "energyProjectType": { "energyProjectTypeCode": "string", "energyProjectTypeId": 1, "energyProjectTypeInfo": "string"
}, "energySavings": { "energySavings": 1.0, "energySavingsUnit": {}
}, "expectedImpact": "string", "fundingSource": "string", "installationBeginDate": "2026-06-29", "installationCost": 1.0, "installationEndDate": "2026-06-29", "note": "string", "place": { "isDataRolledUp": false, "placeCode": "string", "placeId": 1, "placeInfo": "string"
}, "projectManager": "string", "utilityRebate": 1.0
}
]
404
Not Found
The requested resource was not found. Verify the ID or path is correct.