Sign in

v1

latestOpenAPI 3.0.02026-07-22201291.8 MB
/thermostats

List Thermostats

Returns a list of all thermostats.

post/thermostats/list

Request body

connect_webview_idstring uuid

ID of the Connect Webview for which you want to list devices.

connected_account_idstring uuid

ID of the connected account for which you want to list devices.

connected_account_idsstring[]

Array of IDs of the connected accounts for which you want to list devices.

created_beforestring date-time

Timestamp by which to limit returned devices. Returns devices created before this timestamp.

custom_metadata_hasobject

Set of key:value custom metadata pairs for which you want to list devices.

customer_keystring

Customer key for which you want to list devices.

device_idsstring[]

Array of device IDs for which you want to list devices.

device_type'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'

Device type by which you want to filter thermostat devices.

device_typesstring[]

Array of device types by which you want to filter thermostat devices.

limitnumber float

Numerical limit on the number of devices to return.

manufacturer'ecobee' | 'honeywell_resideo' | 'nest' | 'sensi' | 'smartthings' | 'tado'

Manufacturer by which you want to filter thermostat devices.

page_cursorstring nullable

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

searchstring

String for which to search. Filters returned devices to include all records that satisfy a partial match using device_id (full or partial UUID prefix, minimum 4 characters), connected_account_id, display_name, custom_metadata or location.location_name.

space_idstring uuid

ID of the space for which you want to list devices.

unstable_location_idstring uuid nullable

Deprecated. Use space_id.

user_identifier_keystring

Your own internal user ID for the user for which you want to list devices.

Response

OK