Skip to main content
GET
Get configuration

Authorizations

x-api-key
string
header
required

Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.

Path Parameters

id
string
required

The tap ID

Response

Success

active_timeout_s
integer

Seconds the tap stays on after it is turned on.

Example:

120

default_flow
number

Flow the tap starts at, in L/min.

Example:

2

default_temp
number

Temperature the tap starts at, in °C.

Example:

36

min_flow
number

Lowest flow a user can set, in L/min.

Example:

1

min_temp
number

Lowest temperature a user can set, in °C.

Example:

1

max_flow
number

Highest flow a user can set, in L/min.

Example:

12

max_temp
number

Highest temperature a user can set, in °C.

Example:

44

shower
boolean

Switches the Control dial to a shower interface, for a tap that runs a shower.

Example:

false

theme
integer

Control dial theme: 0 light, 1 dark.

Example:

0

time_zone_name
string

IANA time zone of the tap, used for its clock.

Example:

"Europe/Stockholm"

units
integer

Units shown on the Control dial: 0 metric (L/min, °C), 1 imperial (gpm, °F). The API always uses metric.

Example:

0

wall_clock_12_hour_format
boolean

Shows the Control dial clock in 12-hour (AM/PM) format.

Example:

false

wall_clock_enabled
boolean

Shows a clock on the Control dial.

Example:

false

welcome_message_enabled
boolean

Shows a welcome message when the tap is turned on.

Example:

false

welcome_message
string

Text of the welcome message, under 36 bytes in UTF-8.

Example:

"Welcome!"