Systems API

Find the water, wastewater, or related operating systems available to your token, including their Waterly type and time zone.

List systems

Use system_group_id to return systems from one group. Omit it to return systems across the token's organization.

GET/api/systems/v1

curl --digest \
  --user "$WATERLY_API_USERNAME:$WATERLY_API_SECRET" \
  "https://connect.waterly.com/api/systems/v1?system_group_id=8"

{
  "data": [{
    "kind": "system", "id": 40, "name": "Clearwater Wastewater",
    "parent": { "kind": "systemGroup", "id": 8 },
    "order": null,
    "attributes": { "time_zone": "America/Indiana/Indianapolis", "type": "wastewater" }
  }],
  "links": { "self": "...", "next": null, "prev": null },
  "meta": { "limit": 50, "has_next": false, "has_prev": false }
}

Get one system

GET/api/systems/v1/{systemId}

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

Follow links.parent to its system group or links.children to discover the system's sites.

System-specific attributes

Field	Meaning
attributes.time_zone	IANA time zone configured for this system. Use it when presenting local dates and times.
attributes.type	Waterly's classification for the system, such as water or wastewater.