API Guidedata-model:read

Sites API

Discover the physical or logical operating locations that belong to a Waterly system.

List sites

Filter by system_id when you need sites from one system. Results are cursor-paginated.

GET/api/sites/v1

curl --digest \
  --user "$WATERLY_API_USERNAME:$WATERLY_API_SECRET" \
  "https://connect.waterly.com/api/sites/v1?system_id=40&limit=100"

{
  "data": [{
    "kind": "site", "id": 55, "name": "North Treatment Plant",
    "parent": { "kind": "system", "id": 40 },
    "order": 1, "attributes": { "site_type": "treatment_plant" }
  }],
  "links": { "self": "...", "next": null, "prev": null },
  "meta": { "limit": 100, "has_next": false, "has_prev": false }
}

Get one site

GET/api/sites/v1/{siteId}

curl --digest --user "$WATERLY_API_USERNAME:$WATERLY_API_SECRET" \
  "https://connect.waterly.com/api/sites/v1/55"

Follow links.children to list the processes at this site.

Site-specific fields

order is the site's configured display order and may be null.
attributes.site_type describes the site's configured role.
parent.id is the system ID you can reuse in site and data-point filters.