Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
connect_webview_id
string<uuid>

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

connected_account_id
string<uuid>

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

connected_account_ids
string<uuid>[]

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

created_before
string<date-time>

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

custom_metadata_has
object

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

customer_key
string

Customer key for which you want to list devices.

device_ids
string<uuid>[]

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

device_type
enum<string>

Device type by which you want to filter thermostat devices.

Available options:
ecobee_thermostat,
nest_thermostat,
honeywell_resideo_thermostat,
tado_thermostat,
sensi_thermostat,
smartthings_thermostat
device_types
enum<string>[]

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

Device type for thermostats.

Available options:
ecobee_thermostat,
nest_thermostat,
honeywell_resideo_thermostat,
tado_thermostat,
sensi_thermostat,
smartthings_thermostat
limit
number<float>
default:500

Numerical limit on the number of devices to return.

manufacturer
enum<string>

Manufacturer by which you want to filter thermostat devices.

Available options:
ecobee,
honeywell_resideo,
nest,
sensi,
smartthings,
tado
page_cursor
string | null

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

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.

Minimum string length: 1
space_id
string<uuid>

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

unstable_location_id
string<uuid> | null
deprecated

Deprecated. Use space_id.

user_identifier_key
string

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

Response

OK

devices
object[]
required