Skip to main content
GET
/
client
/
showers
List showers
curl --request GET \
  --url https://api.orbital-systems.com/client/showers \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.orbital-systems.com/client/showers"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.orbital-systems.com/client/showers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orbital-systems.com/client/showers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orbital-systems.com/client/showers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.orbital-systems.com/client/showers")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.orbital-systems.com/client/showers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "Count": 123,
  "Items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "state": "<string>",
      "saved_water": 123,
      "saved_energy": 123,
      "sessions": 123,
      "latest_session": "<string>",
      "avg_temperature": 123,
      "avg_session_duration": 123,
      "filter_status": 123,
      "device_group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_connected": "<string>",
      "last_disconnected": "<string>",
      "created_at": "<string>",
      "build_id": "<string>",
      "replace_uv": true,
      "is_cleaning_program_required": true,
      "clean_sensor_tank": true,
      "no_recirculation": true,
      "float_leak": true,
      "operating": {
        "cleaning_programs": 123,
        "inner_heat_treatments": 123,
        "outer_heat_treatments": 123,
        "sessions": 123,
        "sessions_since_cleaning_program": 123,
        "sessions_since_inner_heat_treatment": 123,
        "sessions_since_outer_heat_treatment": 123,
        "liters_since_last_descaling": 123
      },
      "profile": "<string>",
      "oas_revision": "<unknown>",
      "serial_number": "<string>",
      "wifi_ssid": "<string>",
      "installation_info": {
        "installation_name": "<string>",
        "installation_date": "<string>"
      },
      "installation_test": {
        "id": "<string>"
      },
      "type": "<string>",
      "base": 123,
      "control_dial_notifications": true,
      "hibernating": true,
      "updated_at": "<string>",
      "avg_water_recirculation_rate": 123,
      "descaling_status": 123,
      "role": "<string>"
    }
  ]
}
{}
{}
{}

Authorizations

x-api-key
string
header
required

Response

List of showers retrieved successfully

Count
integer
Items
object[]