@seamapi/http - v2.0.0
    Preparing search index...

    Type Alias ThermostatsListParameters

    type ThermostatsListParameters = {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: string;
        custom_metadata_has?: Record<string, unknown>;
        customer_key?: string;
        device_ids?: string[];
        device_type?:
            | "ecobee_thermostat"
            | "nest_thermostat"
            | "honeywell_resideo_thermostat"
            | "tado_thermostat"
            | "sensi_thermostat"
            | "smartthings_thermostat";
        device_types?: (
            | "ecobee_thermostat"
            | "nest_thermostat"
            | "honeywell_resideo_thermostat"
            | "tado_thermostat"
            | "sensi_thermostat"
            | "smartthings_thermostat"
        )[];
        limit?: number;
        manufacturer?: | "ecobee"
        | "honeywell_resideo"
        | "nest"
        | "sensi"
        | "smartthings"
        | "tado";
        page_cursor?: string;
        search?: string;
        space_id?: string;
        unstable_location_id?: string;
        user_identifier_key?: string;
    }
    Index
    connect_webview_id? connected_account_id? connected_account_ids? created_before? custom_metadata_has? customer_key? device_ids? device_type? device_types? limit? manufacturer? page_cursor? search? space_id? unstable_location_id? user_identifier_key?
    connect_webview_id?: string

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

    connected_account_id?: string

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

    connected_account_ids?: string[]

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

    created_before?: string

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

    custom_metadata_has?: Record<string, unknown>

    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[]

    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_types?: (
        | "ecobee_thermostat"
        | "nest_thermostat"
        | "honeywell_resideo_thermostat"
        | "tado_thermostat"
        | "sensi_thermostat"
        | "smartthings_thermostat"
    )[]

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

    limit?: number

    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.

    Optionalpage_cursor

    page_cursor?: string

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

    search?: string

    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_id?: string

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

    unstable_location_id?: string

    Use space_id.

    user_identifier_key?: string

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

    Settings
    Member Visibility

    On This Page
    Properties