GET /api/v3/energyStar/pmProperty

Retrieves the list of Portfolio Manager properties available for linking

GetPortfolioManagerPropertiesV3 Permissions: BuildingsAndOrganizations (View)
Use this endpoint to get properties from the connected Portfolio Manager account. Set includeOnlyUnlinked to true to see only properties not yet linked to EnergyCAP places. Set verbose to false for faster response with only ID and name (use type and floor area will be null). Requires ENERGY STAR to be configured. Requires Buildings and Organizations View permission.

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.

Query Parameters

Name Description Type Required
includeOnlyUnlinked When true, returns only properties not yet linked to an EnergyCAP place boolean Optional
verbose When true (default), includes property use type, floor area, and floor area units from Portfolio Manager. When false, only retrieves ID and name for faster performance boolean Optional

Responses

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

Response Body Parameters

Array of:

EnergyStarPmProperty
Property Description Type
place PlaceChild
PlaceChild properties
Property Description Type
isDataRolledUp Tells whether or not the place’s data is rolled up to its parents. boolean
placeCode The place code string
placeId The place identifier integer (int32)
placeInfo The place info string
placeType PlaceTypeResponse
PlaceTypeResponse properties
Property Description Type
icon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
isSystemPlaceType Flag to indicate if the place type is a system-level place type boolean
placeEntityType PlaceEntityTypeV202406
PlaceEntityTypeV202406 properties
Property Description Type
placeEntityTypeId The place entity type identifier integer (int32)
placeEntityTypeInfo The place entity type name string
placeTypeCode The place type code string
placeTypeId The place type identifier integer (int32)
placeTypeInfo The place type info string
structure Indicates if the place is a structure boolean
placeSize PlaceSizeChild
PlaceSizeChild properties
Property Description Type
beginDate The effective start date for this place size record string (date-time)
endDate The effective end date for this place size record string (date-time)
placeSizeId The identifier for this PlaceSize record integer (int32)
unitCode The code for the unit this place size is measured in Must be between 0 and 16 characters Must be between 0 and 16 characters string
unitId The identifier for the unit this place size is measured in integer (int32)
unitInfo The name of the unit this place size is measured in Must be between 0 and 32 characters Must be between 0 and 32 characters string
value The value of the current place size record number (double)
pmFloorArea The Portfolio Manager floor area null when not linked to portfolio manager property integer (int32)
pmFloorAreaUnits The Portfolio Manager floor area units null when not linked to a portfolio manager property string
pmPropertyId The Portfolio Manager property identifier null when not linked to a portfolio manager property integer (int64)
pmPropertyName The Portfolio Manager property name null when not linked to a portfolio manager property string
pmPropertyUseType The Portfolio Manager property use type null when not linked to a portfolio manager property string
Example Response application/json 
[
  {    "place": {      "isDataRolledUp": false,      "placeCode": "string",      "placeId": 1,      "placeInfo": "string",      "placeType": {}
    },    "placeSize": {      "beginDate": "2026-06-29",      "endDate": "2026-06-29",      "placeSizeId": 1,      "unitCode": "string",      "unitId": 1,      "unitInfo": "string",      "value": 1.0
    },    "pmFloorArea": 1,    "pmFloorAreaUnits": "string",    "pmPropertyId": 1,    "pmPropertyName": "string",    "pmPropertyUseType": "string"
  }
]