List Sites

get

https://api.arcadia.com/plug/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

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
yearBuilt

globalSearch

string

A global search query string. See this page for more information.

page

integer

Defaults to 0

Zero-based page index (0..N)

size

integer

Defaults to 20

The size of the page to be returned

sort

array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort

Headers

Arcadia-Version

string

required

Defaults to 2024-02-21

The Arcadia-Version for the request

string

enum

Defaults to application/hal+json

Generated from available response content types

Allowed:

Response

200OK