List Thermostats

Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.

/thermostats/list

post

Returns a list of all thermostats.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
customer_keystringOptional

Customer key for which you want to list devices.

connected_account_idstring Β· uuidOptional

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

connected_account_idsstring Β· uuid[]Optional

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

connect_webview_idstring Β· uuidOptional

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

device_typestring Β· enumOptional

Device type by which you want to filter thermostat devices.

Possible values:
manufacturerstring Β· enumOptional

Manufacturer by which you want to filter thermostat devices.

Possible values:
device_idsstring Β· uuid[]Optional

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

limitnumber Β· floatOptional

Numerical limit on the number of devices to return.

Default: 500
created_beforestring Β· date-timeOptional

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

user_identifier_keystringOptional

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

page_cursorstring | nullableOptional

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

unstable_location_idstring Β· uuid | nullableOptionalDeprecated
space_idstring Β· uuidOptional

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

searchstring Β· min: 1Optional

String for which to search. Filters returned devices to include all records that satisfy a partial match using device_id, display_name, custom_metadata or location.location_name.

Responses
200

OK

application/json
post
/thermostats/list

Code Example

Request Body Parameters

Parameter
Type
Description

connected_account_id

String Optional

ID of the connected account to which the thermostats belong

connected_account_ids

Array<string> Optional

IDs of the connected accounts to which the thermostats belong

connect_webview_id

String Optional

ID of the Connect Webview that connected the thermostats to Seam

device_type

String Optional

Account type of the thermostats

manufacturer

String Optional

ID of the workspace

device_ids

Array<string> Optional

Device IDs of the thermostats

user_identifier_key

String Optional

Your own internal user ID for the user by which to filter thermostats

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

Last updated

Was this helpful?