v1
latestOpenAPI 3.0.12026-07-248498266.5 KBSites
List Sites
The sites endpoint allows you to get a list of all the sites that are in the Arcadia system. A site object allows you to group credentials, accounts, meters, and statements by a location or another logical grouping for your system. This endpoint is pageable.
This endpoint supports Sandbox Mode.
get/plug/sites
Query parameters
searchstring
A search query string. See this page for more information.
The searchable fields for this endpoint are:
- accountIds
- addressIssueType
- area
- buildingType
- buildingTypeGroup
- city
- country
- createdAt
- createdBy
- fullAddress
- heatingFuel
- hvacCoolType
- hvacHeatType
- hvacVentType
- id
- isLocationRecommendationIgnored
- lastModifiedAt
- lastModifiedBy
- meterIds
- numberOfStories
- postalCode
- recipient
- serviceAddress
- siteCode
- siteName
- siteNumber
- state
- streetLine1
- streetLine2
- totalMeters
- yearBuilt
globalSearchstring
A global search query string. See this page for more information.
pageinteger
Zero-based page index (0..N)
sizeinteger
The size of the page to be returned
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Headers
Arcadia-Versionstring required
The Arcadia-Version for the request
Response
OK