Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Sites

Retrieve Site

If you have the siteId, you can use this endpoint to retrieve the details for that specific site.

This endpoint supports Sandbox Mode.

get/plug/sites/{siteId}

Path parameters

siteIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK

addressIssueType'INCOMPLETE_ADDRESS' | 'UNVERIFIED_ADDRESS' | 'VERIFIED_ADDRESS' nullable required

Issue type of a site's address.

areainteger nullable required

The area of the Site in square feet.

buildingType'FULL_SERVICE_RESTAURANT' | 'HOSPITAL' | 'LARGE_HOTEL' | 'LARGE_OFFICE' | 'MEDIUM_OFFICE' | 'OUTPATIENT' | 'PRIMARY_SCHOOL' | 'QUICK_SERVICE_RESTAURANT' | 'RETAIL_STANDALONE' | 'RETAIL_STRIPMALL' | 'SECONDARY_SCHOOL' | 'SMALL_HOTEL' | 'SMALL_OFFICE' | 'WAREHOUSE' | 'OTHER' nullable required

The type of building.

buildingTypeGroup'EDUCATION' | 'FOOD_SERVICE' | 'HEALTHCARE' | 'LODGING' | 'MERCANTILE' | 'OFFICE' | 'WAREHOUSE_AND_STORAGE' | 'OTHER' nullable required

The group of building types.

createdAtstring date-time nullable required

A timestamp indicating when the entity was created.

createdBystring nullable required

User or system responsible for creating the entity.

facilityTypestring nullable required

Custom field for you to input site’s facility type. Deprecated in favor of buildingType.

heatingFuel'ELECTRICITY' | 'NATURAL_GAS' | 'PROPANE' | 'DISTRICT' | 'FUEL_OIL' | 'OTHER' | 'NONE' nullable required

The type of heating fuel used in the Site.

hvacCoolType'CHILLER' | 'DIRECT_EXPANSION' | 'DISTRICT' | 'EVAPORATIVE' | 'HEAT_PUMP' | 'OTHER' | 'NONE' nullable required

The type of cooling system in the Site.

hvacHeatType'DISTRICT' | 'ELECTRIC_RESISTANCE' | 'FURNACE_OR_BOILER' | 'HEAT_PUMP' | 'OTHER' | 'NONE' nullable required

The type of heating system in the Site.

hvacVentType'ROOFTOP_UNIT' | 'ZONE_TERMINAL' | 'FORCED_AIR' | 'OTHER' | 'NONE' nullable required

The type of ventilation system in the Site.

idstring required

A unique identifier for the entity.

isLocationRecommendationIgnoredboolean required

Indicates if a site has been opted out of address verification.

lastModifiedAtstring date-time nullable required

The timestamp indicating when this resource was last modified.

lastModifiedBystring nullable required

The user or system that last modified this resource.

meterIdsstring[] nullable required

Deprecated: prefer listing Meters filtered by siteId. An array of unique identifiers for multiple meters. Null for non-root users.

numberOfStoriesinteger nullable required

The number of stories of the Site.

regionstring nullable required

The region or geographic area associated with the Site.

siteCodestring nullable required

A code or identifier assigned to a specific site.

siteNamestring nullable required

The name or label assigned to a specific Site.

siteNumberstring nullable required

The number or identifier assigned to a specific Site.

subRegionstring nullable required

A subregion or subdivision within a larger region, such as a county or district.

totalMetersinteger required

Total number of meters associated with this site.

yearBuiltinteger nullable required

The year the Site was built.